Cómo utilizar los tokens de la API de cPanel

Cómo utilizar los tokens de la API de cPanel


Última modificación: 17 de septiembre de 2021

Visión general

En cPanel & WHM versión 80, presentamos tokens de interfaz de programación de aplicaciones (API) de cPanel. Los usuarios de cPanel pueden emitir estos tokens de API. El servidor reconoce los tokens de API y permite a otros usuarios ejecutar funciones de API con los datos de la cuenta. Las funciones de la API le permiten ver y cambiar los datos de la cuenta sin la necesidad de iniciar sesión en la interfaz de cPanel. Por ejemplo, puede emitir un token de API a un desarrollador externo. Ese desarrollador externo podría usar ese token para verificar el uso del disco.

Nota:

  • Los tokens de API se ejecutan UAPI funciones y cPanel API 2 funciones, no cPanel API 1 funciones.
  • Para obtener más información sobre el uso de las funciones de la API, lea nuestro Guía de desarrollo de inicio rápido documentación.
  • Si lo haces no ver esta función, el administrador del sistema la ha desactivado. Póngase en contacto con ellos y pídales que habiliten esta función en WHM Administrador de funciones interfaz (WHM >> Inicio >> Paquete >> Administrador de funciones).

Cómo utilizar un token de API de cPanel

Para usar un token de API de cPanel, primero cree un token de API de cPanel en cPanel’s Administrar tokens de API interfaz (cPanel >> Hogar >> Seguridad >> Administrar tokens de API). Luego, use el token para ejecutar funciones de API en el servidor.

Crea un token de API

Puede utilizar uno de los siguientes métodos para crear un token de API:

Nota:

  • En cPanel & WHM versión 82, cuando un token de API caduca, el sistema no eliminarlo. usted debe eliminar manualmente un token de API.
  • Puede eliminar un token de API con cPanel’s Administrar tokens de API interfaz (cPanel >> Inicio >> Seguridad >> Administrar tokens API) o la UAPI Tokens::revoke función.

Ejecuta funciones de API con el token

Recordar:

usted debe use el token de API que creó en cPanel.

Para llamar a un UAPI o cPanel API 2 función con un token de API, ejecute el siguiente comando desde la línea de comandos:

curl -H'Authorization: cpanel username:APITOKEN' 'https://example.com:2083/execute/Module/function?parameter=value'

Este ejemplo usa el siguiente formato:

Artículo Descripción Ejemplo
username El nombre de usuario de la cuenta de cPanel. username
APITOKEN El token de API. U7HMR63FGY292DQZ4H5BFH16JLYMO01M
example.com El dominio de su servidor cPanel. example.com

Nota:

Alternativamente, puede ingresar la dirección IP de su servidor.

Module La API módulo nombre. Email
function La API la función nombre. add_pop
parameter Los parámetros de entrada de la función. email
value El valor para asignar al parámetro de entrada. 12345luggage

Por ejemplo, su comando puede parecerse al siguiente ejemplo:

curl -H'Authorization: cpanel username:U7HMR63FHY282DQZ4H5BIH16JLYSO01M' 'https://example.com:2083/execute/Email/add_pop?email=newuser&password=12345luggage'

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *