Obtención de Token
Para asegurar la veracidad de las interacciones de nuestra API se requiere la autenticación de peticiones por medio de las llaves brindadas por Pagando Check².
Tipo de petición: POST
Ruta de petición: https://api.pagandocheck.com/v1/pagando/get-token.
| Campo | Tipo | Descripción. |
|---|---|---|
user | String | Identificador de la organización con la que se realizaran operaciones. |
password | String | Contraseña provista por la plataforma de Pagando Check² para realizar transacciones con la llave de usuario. |
Ejemplo de parámetros
{
"user": "6cff8f129ea89aa72746665e840639a9888XXXXX",
"password": "Test 5480e57b5d130f2bbee9882f9871f4fXXXXXXX"
}
Ejemplo de respuesta
Todas las respuestas de API se encuentran homologadas para asegurar consistencia con el cliente, puedes conocer más a fondo en el glosario de respuestas.
Así mismo, los campos generales type, key, message, code vienen explicados en ese mismo glosario.
Respuesta exitosa
{
"type": "API_AUTHENTICATION",
"key" : "TOKEN",
"message": "Success",
"code": 0,
"data": {
"token": "<TOKEN>",
"key" : "<Llave de encriptación>"
}
}
Explicación de campos
| Campo | Explicación |
token | Token de autenticación a realizar en las peticiones. |
key | Llave de encriptación para uso en servicios |
Respuesta con error
{
"type": "API_AUTHENTICATION",
"key": "INVALID_CREDENTIALS",
"message": "the credentials provided are invalid",
"code": 109
}
Códigos de respuesta
| Código | Mensaje | Explicación |
|---|---|---|
0 | token | Operación exitosa para realizar la autenticación. |
100 | The API key provided has expired | La llave utilizada se encuentra expirada o fue generada una nueva. |
109 | The credentials provided are invalid | El usuario o la llave pública otorgadas en la petición son inválidas |
Uso del token en peticiones
El token agregado deberá ser para cada petición que se quiera realizar del API de pagos, este se debe de introducir dentro del header de Autorization por medio de Bearer Token.
"Autorization" : "Bearer << Token >> '
Nota: el token de autenticación otorgado en la petición de autenticación solo tiene una duración de 24 horas de validez, por lo que será necesario implementar la mecánica de renovación dentro de la aplicación desarrollada por el cliente.
