Visión general #

Esta interfaz le permite ejecutar funciones API de cPanel de forma interactiva.

Advertencia:

Esta característica utiliza datos en vivo de su servidor. Las llamadas a funciones de API pueden cambiar o eliminar datos en su servidor, lo que puede provocar que su servidor falle.

• Lea la documentación de una función detenidamente antes de usarla en la interfaz de Shell de API, un script o mediante cualquier otro método.
• Para ver un ejemplo de la salida de una función específica utilizando datos de prueba, lea la sección Ejemplo para esa función en nuestra Documentación del desarrollador.

Habilite la interfaz API Shell #

Para usar esta función, su proveedor de alojamiento debe habilitarla por usted. Pídales que realicen los siguientes pasos en WHM:

1. Seleccione Activado para la configuración del shell cPanel & WHM API (para desarrolladores) en la pestaña Sistema de la interfaz de Ajustes de ajustes de WHM (WHM >> Inicio >> Configuración del servidor >> Ajustes de ajustes).
2. Otorgue la función API Shell a los usuarios deseados en la interfaz del Administrador de funciones de WHM (WHM >> Inicio >> Paquetes >> Administrador de funciones).

Advertencia:

Debes usar un cuenta de distribuidor para acceder a la interfaz API Shell.

Llamar a una función API #

Para llamar a una función API, realice los siguientes pasos:

1. Seleccione la API que desea usar.

Notas:

• Solo cPanel API versión 2 y UAPI están disponibles en esta interfaz.
• Para obtener más información sobre cada función, lea nuestra Guía de UAPI y la Guía de documentación de cPanel API

1. Seleccione la función API que desea probar en el menú.
2. Ingrese las claves y los valores que desea probar.
3. Para ingresar más claves y valores, haga clic en Agregar.
   • Para seleccionar el primer registro para mostrar de los resultados, ingrese el número en el índice de primeros resultados para mostrar, cuadro de texto basado en cero o use el menú para seleccionar el número.
   • Para limitar el número de resultados que se mostrarán, ingrese el número máximo de resultados en el número máximo de resultados para mostrar el cuadro de texto o use el menú para seleccionar el número.
   • Para filtrar los resultados, haga clic en Agregar en la sección Filtros de la interfaz.
     • Puede especificar el campo que se usará para filtrar los resultados, las condiciones y el término que se aplicará a las condiciones.
     • Para usar más de un filtro, haga clic en Agregar para cada filtro adicional que desee especificar.
   • Para ordenar los resultados, haga clic en Agregar en la sección Ordenaciones de la interfaz.
     • Puede especificar el campo por el que desea ordenar los resultados, las condiciones y si desea invertir el orden de clasificación.
     • Para usar más de un método de clasificación, haga clic en Agregar para cada método de clasificación adicional que desee especificar.
   • Para limitar las columnas a mostrar, haga clic en Agregar en la sección Columnas de la interfaz.
     • Ingrese el número de columna en el cuadro de texto Columna.
     • Para especificar más columnas para mostrar, haga clic en Agregar. Haz clic en Enviar.

Devoluciones de llamadas de API #

Los retornos aparecen en la sección de respuesta de llamada API de la interfaz. Puede ver los resultados en la vista de tabla, vista de árbol o como una respuesta sin formato.

Nota:

La respuesta sin formato separa la respuesta de la llamada API de los encabezados HTTP.