Gestión de la clave API del servidor¶
En este artículo
Información
Una clave API es una forma práctica 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 >> You require a 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
Add new;
- 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;
- Marque la casilla Active para activar la clave;
- Haga clic en el botón
Add new API key.
Se le mostrará la 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.
Editar o eliminar una clave API¶
Para editar o eliminar una clave API, navegue hacia su cuenta o hacia un servidor específico donde haya sido 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 permitirán las llamadas utilizando la clave en el campo IP ACL;
-
cambiar o establecer el método de notificación para iniciar sesión con esta clave API. Esto solo se aplica 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 de verificación 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.
Atención
La clave API no puede ser restaurada una vez que haya sido eliminada.
Uso de una clave API¶
La clave API se puede utilizar de las siguientes maneras:
-
Para obtener el token de sesión requerido para solicitudes posteriores de la API 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 toda la cuenta como a un servidor específico a través de la llamada auth/login, dependiendo de la clave API utilizada. Si la autorización tiene éxito 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 server-specific API keys.
Información sobre el 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 hora del evento.
Obtención de una clave API sin un panel web¶
Se puede obtener una clave API sin utilizar el panel de control web utilizando los API methods for working with API keys. Estos métodos pueden ejecutarse desde la línea de comandos o integrarse en soluciones web.