Obtener access token
Método utilizado para obtener un access token para poder operar con la API de integraciones. Se recomienda hacer cache del token hasta que pierda validez antes de pedir uno nuevo.
POST {env}/1/oauth/tokenBody
{
"client_id": "{{client_id}}",
"client_secret": "{{client_secret}}",
"grant_type": "client_credentials"
}| Parámetro | Tipo | Requerido | Valores aceptados | Descripción |
|---|---|---|---|---|
client_id | string | Si | N/A | Corresponde al client_id de la aplicación. Es entregado mediante email y debe permanecer almacenado de manera segura. |
client_secret | string | Si | N/A | Corresponde al client_secret de la aplicación. Es entregado mediante email y debe permanecer almacenado de manera segura. |
grant_type | string | Si | client_credentials | Corresponde al tipo de acceso. Siempre es un valor fijo. |
Response exitosa: 200 Ok
{
"access_token": "....",
"token_type": "Bearer",
"expires_in": 86400,
"scope": "permission_1 permission_2 ... permission_N"
}Campos de la respuesta
| Atributo | Tipo | Descripción |
|---|---|---|
access_token | string | Corresponde al access_token que posteriormente será utilizado para consumir la API. |
token_type | string | Corresponde al tipo de token. |
expires_in | int | Corresponde al tiempo de validez del token, cada token posee una duración de 24hs. Posteriormente, se debe volver a solicitar un nuevo token para seguir operando. |
scope | string | Corresponde a la lista de permisos otorgados para la integración. |
Responses de error
En caso de que la respuesta http no sea 200, entonces se debe considerar el error.
Todos los errores comparten la siguiente estructura:
| Atributo | Tipo | Descripción |
|---|---|---|
status | int | Http code de respuesta. |
code | string | Código de error, indica la naturaleza del mismo. |
msg | string | Mensaje de error. |
Ejemplo response 400 Bad request:
{
"status": 401,
"code": "param-required",
"msg": "invalid client_id. The value is required"
}