Autenticación

Todas las peticiones realizadas a la API de Admintotal deben incluir un método de autenticación válido.

Actualmente se encuentran disponibles los siguientes métodos:

• API Key (Recomendado)

• JWT

Autenticación mediante API Key (Recomendado)

IMPORTANTE Al utilizar este método es necesario almacenar el api_key de manera segura y evitar exponerlo en código fuente, repositorios públicos o aplicaciones cliente.

La autenticación mediante API Key es el método recomendado para consumir la API de Admintotal.

Primero es necesario autenticar al usuario mediante su nombre de usuario y contraseña. Si las credenciales son correctas, el servicio retornará un api_key.

Este valor deberá enviarse posteriormente en el header api-key de todas las peticiones realizadas a la API.

Obtener API Key

POST https://{clave}.admintotal.com/api/v2/usuarios/login_usuario/

Este endpoint permite autenticar a un usuario y obtener el api_key que será utilizado como token de acceso para consumir los diferentes endpoints de la API.

Request Body

Name	Type	Description
username	string	Nombre del usuario
password	string	Contraseña del usuario

Ejemplo solicitud

{ 
    "username": "johndoe", 
    "password": "contraseña" 
}

200 OK

{
    "ok": true,
    "usuario": {
        "id": 104,
        "api_key": "...",
        "username": "johndoe",
        "nombre": "John Doe",
        ...
    }
}

Enviar el API Key

Una vez obtenido el api_key, deberá incluirse en el header de todas las peticiones:

Ejemplo

Api-key: {api_key}

GET https://{clave}.admintotal.com/api/v2/clientes/ 
Api-key: ...

---

Autenticación mediante JWT

Al utilizar este método de autenticación, TODAS las peticiones realizadas a la API deberán incluir el header Authorization de la siguiente forma: Authorization: Bearer {access_token}

Admintotal también permite autenticarse utilizando JSON Web Tokens (JWT).

Con este método se obtiene un access token y un refresh token. El access token deberá incluirse en el header Authorization de las peticiones.

Obtener token JWT

POST https://{clave}.admintotal.com/api/v2/token/

Este endpoint permite autenticar al usuario y obtener los tokens necesarios para utilizar autenticación JWT.

Request Body

Name	Type	Description
username	string	Nombre del usuario
password	string	Contraseña del usuario

Ejemplo solicitud

{ 
    "username": "johndoe", 
    "password": "contraseña" 
}

200 OK

{ 
    "refresh": "eyJ0XAiO...", 
    "access": "eyJ0eXAiO..." 
}

Refrescar token JWT

El access token tiene un tiempo de vigencia limitado. Cuando expire, puede obtenerse uno nuevo utilizando el refresh token.

POST https://{clave}.admintotal.com/api/v2/refresh/

Request Body

Name	Type	Description
refresh	string	Refresh token obtenido durante la autenticación

Ejemplo solicitud

{ 
    "refresh": "eyJ0XAiO..." 
}

200 OK

{
    "access": "eyJ0eXAiO..." 
}

¿Que método utilizar?

Utilizar API Key ofrece una implementación sencilla y permite autenticar las peticiones mediante un único valor.

Utilizar JWT puede ser una mejor opción cuando se requiere un mayor control sobre la duración de las credenciales de acceso.