Gestión de claves API del servidor¶
En este artículo
Información
Una clave API es una forma conveniente de autorizar solicitudes de API a Invapi y acceder al Control Panel de un servidor específico de forma independiente a su centro de control y cuenta personal.
Para acceder a la cuenta completa o a un servidor específico, genere una clave de acceso API en el área personal del panel de control de Invapi. Siga estas instrucciones para obtenerla.
Obtención de una clave API para un servidor específico¶
-
Vaya a Invapi;
-
Seleccione el servidor al que desea acceder desde el panel de control externo del servidor: My Servers >> Required Server;
-
Genere una clave API:
- Navegue hasta la pestaña Configuration y elija la sección API keys & control panel.
- Haga clic en el botón
Create API key;
- En el campo Name, introduzca el nombre de la clave para identificarla;
- Especifique únicamente las direcciones IP desde las cuales se permitirá el acceso con esta clave en el campo IP ACL, o déjelo en blanco para un acceso sin restricciones;
- Seleccione el método de notificación de inicio de sesión (None, Email, Webhook)
- Marque la casilla Active para activar la clave;
- Haga clic en el botón
Save.
Después de esto, se mostrará su clave API.
Atención
Asegúrese de copiar y guardar el valor de la clave API, 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.
Edición de la clave API¶
Para editar o eliminar una clave API, vaya a su cuenta o a un servidor específico, tal como se describió anteriormente durante su generación, y haga clic en la clave API correspondiente. En la ventana que se abre, puede:
- cambiar el nombre de la clave (campo Name);
- establecer las direcciones IP desde las cuales se permitirán las llamadas utilizando la clave (campo IP ACL);
- habilitarla o deshabilitarla temporalmente (casilla de verificación Active).
A continuación, puede hacer clic en el botón Save para guardar los cambios.
Eliminación de la clave API¶
Para eliminar una clave API, vaya a la sección API Keys del perfil de usuario.
En la lista de claves, busque la que desea eliminar. Haga clic en ....
En el menú desplegable, haga clic en el botón Delete.
Atención
La clave API se elimina sin posibilidad de recuperación.
Uso de una clave API¶
La clave API puede utilizarse de las siguientes maneras:
-
Para obtener el token de sesión requerido para solicitudes de API posteriores a una cuenta o servidor en Invapi, es necesaria la autorización. La autorización se puede obtener mediante una clave API para acceder tanto a la cuenta completa como 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. -
Para acceder al Server Control Panel, que permite el acceso al servidor sin iniciar sesión en su cuenta del Invapi Control Center, y para integrarlo como un módulo independiente en su sistema de facturación para gestionar los servidores de HOSTKEY, debe generar claves API específicas para el servidor.
Información de uso de la clave API¶
En la pestaña Usage history, seleccione una clave específica para una cuenta o servidor y haga clic en ella para ver todos los inicios de sesión realizados con esta clave API 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 la hora del evento.
Obtención de una clave API sin panel web¶
Se puede obtener una clave API sin utilizar el panel de control web mediante el uso de los métodos de API para trabajar con claves API. Estos métodos pueden ejecutarse desde la línea de comandos o integrarse en soluciones web.