Base de connaissances

Administrar tokens API en cPanel

Descripción general

Importante:
  • Esta funcionalidad es experimental . Puede cambiar en futuras versiones.
  • Los tokens de interfaz de programación de aplicaciones (API) sin restricciones pueden acceder a funciones de API que no tienen una característica asociada.

Esta función le permite crear, listar, actualizar y revocar tokens de API. El servidor reconoce los tokens de API y le permite ejecutar funciones de API. Estas funciones le permiten ver y modificar los datos de su cuenta sin necesidad de iniciar sesión en cPanel. Puede emitir tokens de API para que otros puedan ejecutar funciones de API con los datos de su cuenta. Por ejemplo, podría emitir un token de API a un revendedor. Este podría usarlo para comprobar el uso del disco.

Nota:

Crear un token de API

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

  1. Haga clic en Crear . Aparecerá la interfaz "Crear token de API" .
  2. Ingrese un nombre único en el cuadro de texto Nombre del token de API .
    Nota:
    • Un nombre de token de API solo puede contener hasta 50 caracteres.
    • Sólo puede ingresar letras ( azAZ), números ( 09), guiones ( -) y guiones bajos ( _).
  3. Seleccione una de las siguientes opciones de la sección ¿Debe expirar el token de API?:
    • El token API no caducará. — Esto creará un token que no tiene fecha de caducidad.
    • Especificar una fecha de vencimiento. Esto le permite crear un token que vence en una fecha específica. De forma predeterminada, los tokens vencen un año después de la fecha actual. Al seleccionar esta opción, la interfaz muestra la sección "Fecha de vencimiento del token de API" . Use el icono de calendario ( Calendario) para abrir un calendario y seleccionar la fecha de vencimiento deseada. También puede introducir una fecha personalizada en el cuadro de texto del calendario, con el YYYY-MM-DDformato . El token vencerá en la fecha que seleccione a las 23:59:59, hora del servidor.
      Importante:
      • No es posible editar la fecha de vencimiento de un token de API después de su creación.
      • Cuando un token de API caduca, el sistema no lo eliminará. Debe eliminarlo manualmente .
  4. Haga clic en Crear . Aparecerá una nueva interfaz.
    • Para copiar el token de API, haga clic en Copiar . Considere este token como una contraseña. Debe introducirlo cada vez que lo use.
      Advertencia:

      No podrá acceder al token después de salir de la interfaz. Si olvida o extravía este token, deberá revocarlo y crear uno nuevo.

  5. Haga clic en Sí, guardé mi token .
    • Para crear un nuevo token, seleccione la casilla de verificación Crear otro token después de hacer clic en Sí, guardé mi token .
    • Para regresar a la interfaz Lista de tokens de API , desmarque la casilla Crear otro token después de hacer clic en Sí, guardé mi token .

La tabla de tokens API

Esta tabla muestra todos tus tokens de API. Puedes realizar las siguientes funciones:

  • Para mostrar más tokens API por página, haga clic en el ícono de engranaje ( Engranaje) y luego seleccione un número.
  • Para revocar varios tokens:
    1. Marque las casillas de cada token que desee revocar. Seleccione la casilla en la parte superior de la tabla para seleccionar todos los tokens.
    2. Haz clic en Revocar . Aparecerá un mensaje de confirmación.
    3. Haga clic en Revocar tokens de API seleccionados .

La tabla de tokens API contiene la siguiente información:

  • Nombre del token : el nombre del token de API.
  • Creado : la fecha y hora en que creó el token de API.
  • Caduca : si un token de API caduca, la fecha y hora en que caducará el token:
    • Cuando un token de API está a punto de expirar, la interfaz muestra su fila de entrada en amarillo. También muestra un icono de aviso ( Aviso).
    • La interfaz muestra en rojo las filas de entrada de tokens de API caducados. También muestra un icono de aviso ( Aviso).
      Recordar:

      Cuando los tokens de API caducan, el sistema no los elimina. Debe eliminarlos manualmente.

  • Administrar : haga clic en Administrar para abrir una nueva interfaz donde puede realizar las siguientes acciones:
    • Cambiar nombre de token : asigne un nuevo nombre al token.
    • Revocar el token : elimine el token y evite que acceda al servidor o a cualquier función de API.

Administrar un token de API

Para administrar un token de API, búsquelo en la tabla "Tokens de API" y haga clic en "Administrar" . Aparecerá la interfaz "Administrar token de API" .

Cambiar el nombre del token

Para asignar un nuevo nombre al token, introdúzcalo en el cuadro de texto " Nuevo nombre de token de API" . Luego, haga clic en Actualizar .

Revocar el token

Advertencia:

Si revoca un token de API, los usuarios no podrán ejecutar ningún script ni función de API utilizando ese token.

Para revocar un token de API:

  1. Haz clic en Revocar . Aparecerá un mensaje de confirmación.
  2. Haga clic en Sí, revocar el token para revocar el token.
Nota:

Para eliminar un token de API en la línea de comando, utilice la Tokens::revokefunción UAPI.

  • 0 Utilisateurs l'ont trouvée utile
Cette réponse était-elle pertinente?