Descripción general

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

Habilitar la interfaz API Shell

Para usar esta función, su proveedor de hosting debe habilitarla. Solicite que realice los siguientes pasos en WHM:

1. Seleccione Activado para la configuración del shell de API de cPanel y WHM (para desarrolladores) en la pestaña Sistema de la interfaz de Configuración de ajustes de WHM ( WHM » Inicio » Configuración del servidor » Configuración de ajustes ).
2. Otorgue la función API Shell a la lista de funciones de su cuenta en la interfaz del Administrador de funciones de WHM ( WHM » Inicio » Paquetes » Administrador de funciones ).

Llamar a una función API

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

1. Seleccione la opción UAPI (API 3) o API 2 en la sección Versión de API de cPanel .
2. Seleccione la función API del menú de la versión API seleccionada.
3. En la sección Variables , introduzca las claves y los valores de la función API en los cuadros de texto. Si la función API requiere pares clave-valor, deberá introducirlos.
   • Para agregar una nueva entrada de variable, haga clic en Agregar .
   • Para eliminar una entrada variable, haga clic en el icono X.
4. Para filtrar, ordenar o paginar los resultados, haga clic en Mostrar opciones de ordenamiento/filtro/paginado :
   • Para seleccionar el primer registro a mostrar de los resultados, ingrese un número en el cuadro de texto Índice de primeros resultados a mostrar, basado en cero o use el menú para seleccionar un número.
     • Un 0valor muestra resultados ilimitados.
   • Para limitar la cantidad de resultados a mostrar, ingrese un número en el cuadro de texto Número máximo de resultados para mostrar o use el menú para seleccionar un número.
     • Un 0valor muestra resultados ilimitados.
   • 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 ( Contiene , Empieza por , Es igual a , Mayor que (numérico) o Menor que (numérico) ) y el término que se aplicará a las condiciones.
     • Para agregar un nuevo filtro, haga clic en Agregar .
     • Para eliminar un filtro, haga clic en el icono X.
   • Para ordenar los resultados, haga clic en "Añadir" en la sección "Ordenar" de la interfaz. Puede especificar el campo por el que desea ordenar los resultados, las condiciones ( lexicográfico , numérico , numeric_zero_as_max o ipv4 ) y si desea invertir el orden de clasificación.
     • Para agregar un nuevo método de clasificación, haga clic en Agregar .
     • Para eliminar un orden de clasificación, haga clic en el ícono X.
   • Para limitar las columnas que se muestran, haga clic en " Agregar" en la sección "Columnas" de la interfaz. A continuación, introduzca el número de columna en el cuadro de texto "Columna" .
     • Para agregar más columnas para mostrar, haga clic en Agregar .
     • Para eliminar una columna, haga clic en el icono X.
5. Haga clic en Enviar .

A medida que modifica los valores de la función API, la interfaz actualiza las entradas de las secciones de estructura de datos de llamada API y URL .

Respuesta de llamada de API

Tras hacer clic en "Enviar" , los resultados de la función API aparecen en la sección de respuesta de la llamada API de la interfaz. Puede ver los resultados en las pestañas Vista de árbol , Vista de tabla y Vista sin procesar .