Gestión de API Keys para el acceso a la cuenta de Invapi¶
En este artículo
La API key funciona como un medio conveniente de autenticación para un acceso fluido a las solicitudes de la API a Invapi.
Atención
Obtener una API key de la cuenta solo es posible si la cuenta tiene un saldo positivo (distinto de cero).
La API access key se genera en la cuenta personal del panel de control de Invapi para el acceso a toda la cuenta o a un servidor específico. Para obtener una API key para la cuenta, siga estas instrucciones:
Obtención de una API Key para toda la cuenta de Invapi¶
-
Navegue hasta Invapi y haga clic en Username >> API keys.
-
Haga clic en el botón
New API keypara crear una API key.
- 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.
- Elija un método de notificación para el acceso a la cuenta utilizando esta API key en la lista desplegable Set login notification method. Las opciones incluyen:
- None (sin notificación);
- Webhook - envía la 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 añadir una nueva API key, haga clic en el botón con la etiqueta
Create.
Se le mostrará la API key.
Atención
Asegúrese de copiar y guardar el valor de la API key, ya que solo se mostrará una vez. Invapi solo almacena el valor hash de la clave, por lo que, si se pierde la clave original, será necesario volver a crearla.
Gestión de API Keys para toda la cuenta de Invapi¶
Para editar o eliminar una API key, navegue hasta 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 podrá:
- cambiar el nombre de la clave en el campo Name;
- establecer las direcciones IP desde las cuales se prohibirán las llamadas utilizando la clave en el campo IP ACL;
- cambiar o establecer el método de notificación para el inicio de sesión con esta API key. Esto se aplica solo a las 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 API key, haga clic en el botón Delete API key.
Atención
La API key no puede ser restaurada una vez que ha sido eliminada.
Uso de la API Key para toda la cuenta de Invapi¶
La API key puede utilizarse para obtener el token de sesión requerido para solicitudes posteriores de la API a una cuenta en Invapi; la autorización es necesaria. La autorización puede obtenerse mediante una API key para el acceso ya sea a toda la cuenta o a un servidor específico a través de la llamada auth/login, dependiendo de la API key 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 API Key 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 API key durante un periodo determinado. El resultado 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 API Key para toda la cuenta de Invapi sin panel de control web¶
Se puede obtener una API key sin utilizar el panel de control web utilizando los métodos de la API para trabajar con API keys. Estos métodos pueden ejecutarse desde la línea de comandos o integrarse en soluciones web.