Autenticacion
Autenticación de los proveedores logisticos para el uso de el webhook
Importante
- La vida útil del token por defecto va a ser de 21 HORAS.
- NO se requiere! que para cada petición, se necesite un nuevo token.
- Todas las respuestas tienen una descripción del resultado, asi como un status_code.
- Verifica que el token este vigente, en la respuesta se facilita esa información.
- Si el token esta vencido se retorna { "status": "401", "title":"Unauthenticated" "message":"The signature is invalid." }.
- Y más importante, se reservo el codigo de estad: 401, para el vencimiento del token.
Request 🚀
url
https://api.aveonline.co/api-webhook/public/api/v1/login
Method
POST
Header
Content-Type: application/json
Accept: application/json
Params JSON
- tipo*
String
Enrutador de la API, "webhook_auth"
- data*
Object -> {}
Datos relevantes para la Autenticación
- idtransportadora*
Number
Número identificador del Proveedor
- reason*
String
Intención explícita del WebHook, "actualizar_estados_guias"
- idtransportadora*
Ejemplo
{
"type": "webhook_auth",
"data": {
"idtransportadora": 1026,
"reason": "actualizar_estados_guias"
}
}
Response 📄
Success
- status :
String
- data* :
Object -> [{}]
- signature_hash :
String
Token JWT< xxx.xxx.xx >
- signature_hash_issued_at :
String
Respuesta en DateTime, espicfica la fecha de firmado de el token
- signature_hash_expires_at :
String
Respuesta en DateTime,especifica la fecha de vencimiento de el token
- signature_hash_date_expires_at_for_humans
String
Horas que faltan para la expiracion del token
- signature_hash :
Ejemplo
{
"status": "success",
"data": {
"signature_hash": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0IiwiYXVkIjoiMGQwYTRhYjg2ZTdjMTM0NWI4Mjk2MTc5ZDNhNTQzMmUiLCJpYXQiOjE2NzIyMzk2MTMuOTIwNjE2LCJleHAiOjE2NzIzMTg4MTMuOTIwNjIsInRyYW5zcG9ydF9pZCI6MTAyNiwidHJhbnNwb3J0X25hbWUiOiJEb21pbmEifQ.t5eS40hzfqgxCsoM1kS6ZgucoF8VkkKogL6H8LFhHe__ovPWXNDKhRi_mQsEpQ0fFJcjqmqcfA-NFK-MgnS0ZDSX2PCIJUxWHbTtGf1xp0GPTHaRUECQLKlEvRh1pLf71VRflqq6GqKlljq9_anT1wbGqABohNXcgQ4pLY47sTuktj1x-SU0FxYiRETa58ErTbbncbROIFEAKoQF3uvfNcrD7imrldu0AyrdLnYXgiwAai5pg6IOKby5pzRGwyet0H89gjdF1DMTQhVXVlTEyP0PZEzOvVCB5BRTPOhcm1nY0oIfCxVLcpgRRU6hDB9yZ1HQoCWxfxVdqLveRKxHqLBe_tsOLMbXTVNHGCjh75LjYD4VT03qSxaWnLwV6ltLWLKiPb_9zbU-aCt3w9RF_Mrv6SL6S_Rb1UnXIspcYkQ4r863Z_4BB7J6I2cYfroGsBGQM2Y06_MXy4KCTWZhFT388EDBL9qjmqm8MqHrUHmknQ97N5FLlLk4e-2LD79o-PzZXKxRExrck3CI_t5QtUqyOc7hWBzrm62rYJhtn-nBlA6GYqe11817RxKOESM1aRTGYg4q1UA0laSCjkJhE_67u6O1-UausXIqsQorys1B_rBQMa-zKDdxOqniv3L38KtmRTqL8UsWkXDMyOU12zwDC91-Zsaee29fv48ZqTrJpoSJYlxsKn4yuHaJ5tgxrftP0buhIxZ18bOp7cuOnYraGV8E3CzCAQ-0bM732FK8g01JdlCIgTRP6Ah66hdgJ2HQeGOZgDCQ5d2BYJ22jtZQR9K9nUFGfPEIHRD_0ZVFoJ_pUc3i8b5AfEUotjl0zcQq9u1_VJfBrERAGnpRGimGWUwL42zR5_-m4AhXWM9pVcjsLbfiBy4cn-TYg_N-hce9zfnd685TThga7tBmObPmrb-0tJdfzsygW_FmzCzYl8r9hASpo3zV-9obLclhfvRrilx8wAb5XQZtPHqkB916CX4FWqO0NP00ziCyDp5snwJw0heMdiXcgxThkcgpF-YtjWosIqSJDQ3xClCj1lrjW_lkO8oUcQlsRJQRrO_M5xfjLgr89SdcdVQO7oZUHo1wi9F0zGsgv5H3gVkkaRmuayRKMacTahHNwRVeK52ACtJvndZofHTutEiQ_GF8e70z0UQLgrvwOMGoYl5VmjmzVOUadGOYcKrq4mfkmvdWdcfaAPJPYfEHqpz6x1D4D_Wfp2H2J-ep5VAAso7x0foaf0a7W87GmwSMXpFTm7aMasH_-DX1YnM_sTOY9-d5uXI1wfr961u6hOjQFvesKVSGxyR4JuPV0nrQ9HjmFdGeJCxYkW-BCQ",
"signature_hash_issued_at": "2022-12-28 15:00:13",
"signature_hash_expires_at": "2022-12-29 13:00:13",
"signature_hash_date_expires_at_for_humans": "21 hours"
}
}
Bad Request
- tittle :
String
Titulo de el erro
- detail :
String
Mensaje descriptivo del error
, - status:
Number
Status Code de el error
{
"errors": [
{
"title": "Bad Request",
"detail": "Verifique su ID de transportadora y vuelva a intentarlo",
"status_code": 400
}
]
}