Gestión de claves API para el acceso a la cuenta de Invapi¶

En este artículo

• Obtención de una clave API para toda la cuenta de Invapi
• Gestión de claves API para toda la cuenta de Invapi
• Uso de la clave API para toda la cuenta de Invapi
• Información de uso de la clave API para toda la cuenta de Invapi
• Obtención de una clave API para toda la cuenta de Invapi sin un panel de control web

Obtención de una clave API para toda la cuenta de Invapi¶

1. Navegue a Invapi y haga clic en Username >> API keys.

2. Haga clic en el botón Add new para crear una clave API.

   

   • Para identificar la clave en el campo Name, introduzca su nombre;
   • En la lista desplegable Restrict a new API key only for the server, seleccione si la clave se aplicará a toda la cuenta (Any) o a un servidor específico;
   • Especifique las direcciones IP desde las cuales se permitirá el acceso utilizando esta clave en el campo IP ACL, o déjelo en blanco para un acceso sin restricciones.
   • Seleccione un método de notificación para el acceso a la cuenta utilizando esta clave API desde la lista desplegable Set login notification method. Las opciones incluyen:
     • None (sin notificación);
     • E-mail
     • Webhook: enviar información de inicio de sesión mediante una llamada HTTP a su sitio web.
   • Si selecciona E-mail o Webhook, introduzca el correo electrónico o la URL correspondiente en el campo Notification address (email/URL).
   • Para activar la clave, marque la casilla Active;
   • Para agregar una nueva clave API, haga clic en el botón etiquetado como Create.

   

   Se le mostrará la clave API.

   

Gestión de claves API para toda la cuenta de Invapi¶

Para editar o eliminar una clave API, navegue a su cuenta donde fue generada y haga clic en la clave deseada. En la ventana que aparece, vaya a la pestaña General Info donde puede:

• cambiar el nombre de la clave en el campo Name;
• establecer las direcciones IP desde las cuales las llamadas utilizando la clave estarán prohibidas en el campo IP ACL;
• cambiar o establecer el método de notificación para el inicio de sesión con esta clave API. Esto se aplica solo a claves emitidas para toda la cuenta e implica el campo de dirección de notificación (email/URL);
• habilitar o deshabilitar temporalmente esta función utilizando la casilla Active.

A continuación, haga clic en el botón Save API key para guardar sus cambios.

Para eliminar una clave API, haga clic en el botón Delete API key.

Uso de la clave API para toda la cuenta de Invapi¶

La clave API se puede utilizar para obtener un token de sesión necesario para solicitudes de API posteriores a una cuenta en Invapi; la autorización es necesaria. La autorización se puede obtener mediante una clave API para acceder a toda la cuenta o a un servidor específico a través de la llamada auth/login, dependiendo de la clave API utilizada. Si la autorización es exitosa y la clave se encuentra en la base de datos, el sistema devolverá el token de sesión $HOSTKEY_TOKEN.

Información de uso de la clave API para toda la cuenta de Invapi¶

En la pestaña Usage history, seleccione una clave específica para una cuenta y haga clic en ella para ver todos los inicios de sesión realizados con esta clave API durante un período determinado. La salida incluirá el correo electrónico y la dirección IP utilizados para el inicio de sesión, su estado de éxito, así como la fecha y hora del evento.

Obtención de una clave API para toda la cuenta de Invapi sin un panel de control web¶

Se puede obtener una clave API sin utilizar el panel de control web utilizando los métodos API para trabajar con claves API. Estos métodos se pueden ejecutar desde la línea de comandos o integrarse en soluciones web