Skip to main content
Version: 1.x(Legacy)

Webhook con la trama Sugerida por Ave

Trama/request sugerida por AveOnline para homogeneidad del Servicio

Se debe contar con el token para el uso de este Servicio

Request 🚀​

url​

https://aveonline.co/api/hooks/tramaoperador.php

Method​

POST

Content-Type: application/json
Authorization: xxxxxxxxxxxxx.xxxxxxxxxxxxx.xxxxxxxxxxxxxxxxx

!RECOMENDACIONES!​

  • La vida útil del token por defecto va a ser de 6 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.
  • Verifica que el token este vigente, en la respuesta se facilita esa información.
  • Si el token esta vencido se retorna { "status": "error", "message":"Token no valido" }.
  • Y más importante, se reservo el StatusCode: 401, para el vencimiento del token.

Params JSON​

  • tipo* String "json" Descripción del formato de la trama a guardar
  • body* Object -> [{}] Trama o tramas para procesar enviada en un Array
    • id_consecutivo* String Número del envio generado por el proveedor
    • cod_estado* String Código del estado de la guia generado por el proveedor
    • nombre_estado* String Nombre del estado de la guia, formato definido por el proveedor
    • fecha_estado* String AAAA-MM-DD HH:MM:ss Fecha actualizada del estado de la guia
    • cod_novedad String "" | null | 0 , si no existe Código de novedad, formato definido por proveedor
    • nombre_novedad String "" | null | 0 , si no existe Nombre de la novedad generado y formato definido por proveedor
    • fecha_novedad String AAAA-MM-DD HH:MM:ss "" | null | 0 , si no existe Código de novedad, formato definido por proveedor
    • estado_novedad String "" | null , si no existe En que estado se encuentra la novedad
    • guia_reeemplazo String "" | null | 0 , si no existe ¡En caso de devolución! Nueva guia de rastreo del envio "CONT" ¡En caso de continuidad!
    • tipo_guia_reeemplazo String "" | null , si no existe reemplazo "DEV" ¡En caso de devolución! "REEMP" ¡En caso de reemplazo de la guia anterior!
    • ruta_digitalizada String "" | null | 0 , si no existe Url de la guia para su posterior descarga
    • observaciones String "" | null | 0 , si no existe Observaciones relevantes al envio

Ejemplo​

{
  "tipo": "json",
  "body": [
    {
      "id_consecutivo": "consecutivo123",
      "cod_estado": "4",
      "nombre_estado": "EN ENTREGA",
      "fecha_estado": "2022-12-11 11:04:43",
      "cod_novedad": "NOVEDAD",
      "nombre_novedad": "DIRECCION ERRONEA",
      "fecha_novedad": "2022-12-11 11:31:00",
      "estado_novedad": "EJECUTADA",
      "guia_reeemplazo": "123-444-222",
      "tipo_guia_reeemplazo": "DEV" | "REEMP" | "CONT",
      "ruta_digitalizada": "https://laruta.com/docs/....",
      "observaciones": "no se encuentra la dirección"
    }
  ]
}

!IMPORTANTE!​

  • En el body se puede enviar información de más de una guia.
  • De ser solo la información de una guia, tambien debe ir dentro de un array.
  • Verifica que el token este vigente, no ser asi no se acepta la petición.
  • Cambios y sugerencias: desarrollo2@aveonline.co, desarrollo3@aveonline.co
  • Si se cambian los campos una vez establecidos, no se tendrá en cuenta esa información.

Response 📄​

Success​

StatusCode: 200
  • status String Estado del resultado
  • message String Mensaje de respuesta
{
  "status": "ok",
  "message": "Informacion guardada exitosamente"
}

Error​

StatusCode: 400...
  • status String Estado del resultado
  • message String Mensaje descriptivo del error
{
  "status": "ok",
  "message": "Token no valido"
}