Skip to main content
Version: Latest

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

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"

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

Ejemplo​

{
    "status": "success",
    "data": {
        "signature_hash": "TU_TOKEN_JWT",
        "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
        }
    ]
}