14.1 Manage API Tokens

Esta interfaz le permite crear, enumerar, actualizar y revocar tokens de API. También le permite asignar privilegios de lista de control de acceso (ACL) a tokens de API. Puede utilizar un token de API para autenticarse con la API remota de WHM. Esto es útil, por ejemplo, para permitir que un revendedor o un desarrollador externo ejecute llamadas a funciones de API con los datos de su cuenta.

La tabla de tokens de API

Esta sección de la interfaz muestra todos sus tokens de API. También puede realizar las siguientes acciones:

• Para buscar un token de API, ingrese un término en el cuadro de texto Buscar . La interfaz filtra automáticamente los nombres de token de API a medida que escribe.
• Para actualizar la lista de tokens de API, haga clic en el icono de engranaje ( ) junto al encabezado de la columna Acciones y haga clic en Actualizar lista .

La tabla de tokens de API muestra lo siguiente:

• Nombre : el nombre del token de la API.

• Creado : la hora a la que creó el token de API, en MM DD YYYY hh:mm:ssformato.

• Caduca : si un token de API caduca, la fecha y hora en que caducará.

  • Cuando un token de API caduca pronto, la interfaz muestra su fila de entrada en amarillo. También muestra un icono de aviso ( ).

  • La interfaz muestra las filas de entrada de token de API caducadas en rojo. También muestra un icono de aviso ( ).

    Nota: Cuando los tokens de API caducan, el sistema no los elimina. Usted debe eliminar manualmente los tokens de la API caducados.

     

  • IP : la dirección IP o el rango de direcciones IP (en formato CIDR) de la persona que llama a la API que puede usar el token. Si la columna contiene Cualquiera , cualquier dirección puede usar el token.

    Nota: Esta función permite un máximo de 100 direcciones IP y / o entradas de rango de direcciones IP.

     

• Comportamiento

  • Editar : edita el token de la API.

  • Revocar : revoca el token de la API.

Crea un token de API

Para crear un token de API, realice los siguientes pasos:

1. Haga clic en Generar token . La Generar API simbólico aparecerá interfaz.

2. Ingrese un nombre único para el token de API en el cuadro de texto Nombre .

   Nota:

   • Un nombre de token de API solo puede contener hasta 50 caracteres.
   • Puede solamente introducir letras ( aa través zy Apor medio Z), números ( 0a través 9), guiones ( -) y guiones ( _).

    

3. Seleccione una de las siguientes configuraciones de la sección ¿Debería expirar el token de API? sección:

   • El token de API no caducará. – Esto creará un token que no tiene fecha de vencimiento.

   • Importante:

     • Cuando un token de API caduca, el sistema no lo eliminará. Usted debe eliminar manualmente un token de API.

     • Puede eliminar un token de API en esta interfaz o utilizar la función WHM API 1 api_token_revoke.

       Especifique una fecha de vencimiento. – Esto le permite crear un token que vence en una fecha específica. De forma predeterminada, los tokens caducan un año después de la fecha actual. Cuando selecciona esta configuración, la interfaz muestra la sección Fecha de vencimiento del token de API . Utilice el icono de calendario ( ) para abrir un calendario y seleccionar la fecha de vencimiento deseada. También puede ingresar una fecha personalizada en el cuadro de texto del calendario. Utilice el YYYY-MM-DDformato, donde YYYYes el año de cuatro dígitos, MMes el mes y DDes el día del mes. El token caducará en la fecha que seleccione a la 11:59:59 PMhora del servidor.

4. En el cuadro de texto IP , ingrese las direcciones IP de los dispositivos que pueden usar este token de API. Puede ingresar direcciones IP en cualquiera de los siguientes formatos:

   • Dirección IP única (por ejemplo, 10.5.3.33).

   • Formato CIDR (por ejemplo, 10.5.3.3/32).

   Nota: Esta configuración está predeterminada para permitir que todas las direcciones IP utilicen el token de la API de WHM.

    
5. Advertencia: Tenga cuidado al asignar los siguientes privilegios de ACL:

   • Todo : esto permite que un usuario de token de API acceda a todo el sistema. Un usuario con este token puede realizar todas rootlas funciones de usuario.

   • Cambiar contraseña : esto permitirá que un usuario de token de API cambie las contraseñas de la cuenta e inicie sesión con una nueva contraseña.

   • Crear sesión de usuario y administrar tokens de API : permitirán que un usuario de token de API eluda cualquier restricción que establezca en el token de API.

     En la sección Privilegios , anule la selección de la casilla de verificación de los privilegios de ACL que no desea otorgar al token. Para obtener más información, lea nuestra documentación Editar servidores de nombres y privilegios de revendedores .

     Nota:

     • Usted debe asignar al menos un privilegio de ACL para el token.

     • En esta sección solo aparecerán los privilegios de ACL que posee el usuario.

6. Haga clic en Generar . Aparecerán el nuevo hash del token de API y su nombre. La interfaz también muestra la fecha en la que caducará el token de la API.

   Advertencia: Hacer cierta que guarde su API token en un lugar seguro en su estación de trabajo. No puede acceder al token después de salir de la interfaz o actualizar la tabla de tokens de API .

    

7. Haga clic en Sí, guardé mi token . El nuevo token de API y su hora de creación aparecerán en la lista de tokens de API .

Editar un token de API

Para editar un token de API, realice los siguientes pasos:

1. Busque el token de API que desea editar en la lista de tokens de API .

2. En la columna Acciones , haga clic en Editar . El Editar API simbólico aparecerá interfaz.

3. Edite la configuración deseada, luego haga clic en Guardar . Aparecerá un mensaje de éxito en la esquina superior derecha de la interfaz.

   Recordar: Usted debe asignar al menos un privilegio de ACL para el token.

Revocar un token de API

Para revocar un token de API, realice los siguientes pasos:

1. Busque el token de API que desea revocar en la lista de tokens de API .

2. En la columna Acciones , haga clic en Revocar . Un mensaje de confirmación aparecerá.

3. Haga clic en Continuar para revocar el token. Aparecerá un mensaje de éxito en la esquina superior derecha de la interfaz.

Para revocar todos los tokens de API, realice los siguientes pasos:

1. Haga clic en el icono de rueda dentada ( ) y haga clic en Revocar todo . Un mensaje de confirmación aparecerá.

2. Haga clic en Continuar para revocar todos los tokens de API. Aparecerá un mensaje de éxito en la esquina superior derecha de la interfaz.