Get Token

La API de Avalisto utiliza JWT (JSON Web Token) para autenticar las solicitudes. Nuestro tipo de autenticación se realiza mediante OAut 2.0 siendo necesarios un usuario y contraseña habilitados. Tus claves API otorgan un alto nivel de acceso, por lo que es fundamental mantenerlas protegidas. Evita compartirlas en espacios públicos como GitHub, código del lado del cliente u otros entornos accesibles.

Antes de poder acceder a los EndPoints de nuestra API los usuarios deben solicitar un token de acceso, este token debe ser incluido en cada solicitud, teniendo un tiempo de uso limitado que nos permite realizar diferentes llamadas a un mismo EndPoint.

Request

📌 Recuerda que Avalsito dispone de varios entornos. Para más información, consulta 🔍 Entornos

Para generar un token de acceso:

1- En Authorization comprobamos los parámetros.

2- Con una solicitud tipo ‘Post’ apuntaremos a la URL del entorno necesario.

3- Indicaremos en el Body la estructura de datos requerida en formato JSON.

4- Código cURL.

1. Authorization (Postman)

Key	Value
Auth Type	OAuth 2.0
Add authorization data to	Request Headers

2. Enter URL (Postman)

Key	Value
URL	{baseURL}
Method	Post
Content-Type	x-www-form-urlencoded

3. Body (Postman)

Key	Value	Requirement	DataType
grant_type	password	Required	String
username	userDocu	Required	String
password	passwordDocu	Required	String

🔷 grant_type: Esto indica que se está utilizando el flujo de “password grant” en OAuth 2.0, que permite a un usuario autenticarse proporcionando su nombre de usuario y contraseña directamente a la API.

🔷 username: Nombre de usuario vinculado a la compañía, proporcionado por el equipo de IT de Avalisto.

🔷 password: Contraseña asociada a la compañía, también suministrada por el equipo de IT de Avalisto.

4. Código cURL

curl --location 'https://api.avalisto.com/recuperartoken' \
--header 'content-type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username=userDocu' \
--data-urlencode 'password=passwordDocu'

Key	Value	Requirement	DataType
location	url	Required	String
content-type	x-www-form-urlencoded	Required	String
grant_type	password	Required	String
username	userDocu	Required	String
password	passwordDocu	Required	String

Response

📌 Una respuesta exitosa nos devolverá

---

✅ 200 OK.       Request successful. The server has responded as required

---

El Body de respuesta será en formato JSON con la siguiente estructura:

{
    "access_token": "RzEl6ppdLbytvB9SxZu8WZZ2WwvZUJPZGnxI36a4J5PFo5bZCjFGqcE2ZfrTPxjtA33_SmbA6AxkkqbcJ_nA7BAXPAA6Ep5j7YtBpJs9wqGykrHZ3uIu5FDOpxnZzTxsIKv1QPBtuxL24A2GNfzWXEMygkwiXst3WaOZJ2301zvvKyTcC1sR6kIWTh1uN6Yen7pruNfs5N0XnkxEMb0T9OInvkUUUEcGhRXBMK-7ot4HP2AlZk8SmKgKdcC7WD9NZeyJoB-H7aNtwofusJCVpTEQpBjRVn6r7orHW7pjhQ5XODVRS1yejSUmcxGb1UNg",
    "token_type": "bearer",
    "expires_in": 172799
}

Variable	DataType
access_token	String
token_type	String
expires_in	Int

🔷 “access_token”: Una vez emitido el token de acceso, el usuario puede realizar solicitudes a los EndPoints, recuerde proporcionar un encabezado de autorización con dicho token.

🔷 “token_type”: Tipo de token emitido.

🔷 “expires_in”: Tiempo expiración del token (48h)

 

❌ Error: Si la solicitud no prosperó, consulta el apartado ⚠️ Errores para más información.

 

Avalisto emplea códigos de respuesta HTTP estándar para señalar el éxito o fracaso de una solicitud a la API. En términos generales:

🔷 Códigos 4xx → Representan errores causados por información incorrecta o incompleta (por ejemplo, falta un parámetro requerido o una transacción ha fallado)..

🔷 Códigos 5xx → Señalan un problema en los servidores de Avalisto (aunque son poco frecuentes).

🔷 Errores de Conexión → Estos errores pueden ocurrir antes de que la solicitud llegue al servidor.

El Body de respuesta será en formato JSON con la siguiente estructura:

{
    "error": "No access.",
    "error_description": "Company doesn't exist or user or password incorrect"
}

Cuando el motivo esté descrito en el mismo error, no tendremos “error_description”:

{
    "error": "unsupported_grant_type"
}

Para evitar errores:

🔍 Verifica la URL y el método HTTP/HTTPS (POST en este caso).

📦 Asegúrate de enviar el body en el formato correcto (JSON, form-data, etc.).

📑 Incluye los encabezados necesarios (Content-Type: application/json, etc.).

⚙️ Confirma que el servidor en la URL está en ejecución y que el puerto seleccionado es accesible.