Consultar todos los eventos transmitidos al webhook

Algunas veces es necesario consultar el historial de eventos enviados al webhook

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

Request 🚀

url

https://api.aveonline.co/api-webhook/public/api/v1/shipping-events-logs

Method

GET

Header

Content-Type: application/json
Accept: application/json
Ave-Hub-signature: <Token JWT Firmado Por AveOnline>

Response 📄

Success

Si todo va bien, deberia ver un JSON con la siguiente estructura

{
  "status": "success",
  "meta": {
    "count_events_received": 2,
    "link": "http://api-webhook.test/api/v1/shipping-events-logs"
  },
  "data": [
    {
      "id": 1,
      "name": "default",
      "url": "http://api-webhook.test/api/v1/shipping-events-hook",
      "id_envio": "85910400510181",
      "payload": {
        "id_envio": "85910400510181",
        "cod_estado": "10",
        "nombre_estado": "ENVíO ENTREGADO AL DESTINATARIO",
        "fecha_estado": "2022-11-09T13:27:27+00:00",
        "nombre_novedad": null,
        "estado_novedad": null,
        "cod_novedad": null,
        "fecha_novedad": null,
        "tipo_guia_reemplazo": null,
        "ruta_digitalizada": null,
        "base64_entrega_digitalizada": {
          "base64": null,
          "mime_type": null
        },
        "observaciones": null
      },
      "payload_format": "json",
      "proveedor": "Domina",
      "idproveedor": 1026,
      "idfecha": "20221228",
      "exception": null,
      "created_at": "2022-12-28T20:26:18.000000Z",
      "updated_at": "2022-12-28T20:26:18.000000Z"
    },
    {
      "id": 2,
      "name": "default",
      "url": "http://api-webhook.test/api/v1/shipping-events-hook",
      "id_envio": "85910400510181",
      "payload": {
        "id_envio": "85910400510181",
        "cod_estado": "10",
        "nombre_estado": "ENVíO ENTREGADO AL DESTINATARIO",
        "fecha_estado": "2022-11-09T13:27:27+00:00",
        "nombre_novedad": null,
        "estado_novedad": null,
        "cod_novedad": null,
        "fecha_novedad": null,
        "tipo_guia_reemplazo": null,
        "ruta_digitalizada": null,
        "base64_entrega_digitalizada": {
          "base64": null,
          "mime_type": null
        },
        "observaciones": null
      },
      "payload_format": "json",
      "proveedor": "Domina",
      "idproveedor": 1026,
      "idfecha": "20221228",
      "exception": null,
      "created_at": "2022-12-28T20:26:18.000000Z",
      "updated_at": "2022-12-28T20:26:18.000000Z"
    }
  ]
}

Para consultar de una manera mas optima los eventos recibidos por el webhook, pudes pasar parametros de consulta atraves de la URL

URL Params

<Si existen parámetros de URL, especifiquelos en la ULR pasando haciendo algo parecido a la siguiente estructura ?query_param=value>

Optional:

Parametro para consultar por numero de guia

Se le pasa el numero de guia debe ser numerico

id_envio=[numeric]

Consultar por rango de fechas

Los ragon de fechas deben estar en el siguiente formato AAAA-MM-DD

fecha_inicio=[datetime]

fecha_inicio=[datetime]

Consultar solo las guias de hoy

Se pasa el query param hoy, con solo existir en la url es mas que suficiente

hoy=[bool

Info

• Esta api cuenta con soporte para xml si deseas ver la salida en xml puede modificar las cabeceras de la peticion a

  Content-Type: application/xml
  Accept: application/xml
  Ave-Hub-signature: <Token JWT Firmado Por AveOnline>

Deberia aparecerte la respuesta en formato xml

<?xml version="1.0" encoding="UTF-8"?>
<document>
    <status>success</status>
    <meta>
        <count_events_received>3</count_events_received>
        <link>http://api-webhook.test/api/v1/shipping-events-logs</link>
    </meta>
    <data>
        <id>4</id>
        <name>default</name>
        <url>http://api-webhook.test/api/v1/shipping-events-hook</url>
        <id_envio>85910400510182</id_envio>
        <payload>
            <id_envio>85910400510182</id_envio>
            <cod_estado>10</cod_estado>
            <nombre_estado>ENVíO ENTREGADO AL DESTINATARIO</nombre_estado>
            <fecha_estado>2022-11-09T13:27:27+00:00</fecha_estado>
            <nombre_novedad></nombre_novedad>
            <estado_novedad></estado_novedad>
            <cod_novedad></cod_novedad>
            <fecha_novedad></fecha_novedad>
            <tipo_guia_reemplazo></tipo_guia_reemplazo>
            <ruta_digitalizada></ruta_digitalizada>
            <base64_entrega_digitalizada>
                <base64></base64>
                <mime_type></mime_type>
            </base64_entrega_digitalizada>
            <observaciones></observaciones>
        </payload>
        <payload_format>json</payload_format>
        <proveedor>Domina</proveedor>
        <idproveedor>1026</idproveedor>
        <idfecha>20221228</idfecha>
        <exception></exception>
        <created_at>2022-12-28T20:41:38.000000Z</created_at>
        <updated_at>2022-12-28T20:41:38.000000Z</updated_at>
    </data>
    <data>
        <id>1</id>
        <name>default</name>
        <url>http://api-webhook.test/api/v1/shipping-events-hook</url>
        <id_envio>85910400510181</id_envio>
        <payload>
            <id_envio>85910400510181</id_envio>
            <cod_estado>10</cod_estado>
            <nombre_estado>ENVíO ENTREGADO AL DESTINATARIO</nombre_estado>
            <fecha_estado>2022-11-09T13:27:27+00:00</fecha_estado>
            <nombre_novedad></nombre_novedad>
            <estado_novedad></estado_novedad>
            <cod_novedad></cod_novedad>
            <fecha_novedad></fecha_novedad>
            <tipo_guia_reemplazo></tipo_guia_reemplazo>
            <ruta_digitalizada></ruta_digitalizada>
            <base64_entrega_digitalizada>
                <base64></base64>
                <mime_type></mime_type>
            </base64_entrega_digitalizada>
            <observaciones></observaciones>
        </payload>
        <payload_format>json</payload_format>
        <proveedor>Domina</proveedor>
        <idproveedor>1026</idproveedor>
        <idfecha>20221228</idfecha>
        <exception></exception>
        <created_at>2022-12-28T20:26:18.000000Z</created_at>
        <updated_at>2022-12-28T20:26:18.000000Z</updated_at>
    </data>
    <data>
        <id>2</id>
        <name>default</name>
        <url>http://api-webhook.test/api/v1/shipping-events-hook</url>
        <id_envio>85910400510181</id_envio>
        <payload>
            <id_envio>85910400510181</id_envio>
            <cod_estado>10</cod_estado>
            <nombre_estado>ENVíO ENTREGADO AL DESTINATARIO</nombre_estado>
            <fecha_estado>2022-11-09T13:27:27+00:00</fecha_estado>
            <nombre_novedad></nombre_novedad>
            <estado_novedad></estado_novedad>
            <cod_novedad></cod_novedad>
            <fecha_novedad></fecha_novedad>
            <tipo_guia_reemplazo></tipo_guia_reemplazo>
            <ruta_digitalizada></ruta_digitalizada>
            <base64_entrega_digitalizada>
                <base64></base64>
                <mime_type></mime_type>
            </base64_entrega_digitalizada>
            <observaciones></observaciones>
        </payload>
        <payload_format>json</payload_format>
        <proveedor>Domina</proveedor>
        <idproveedor>1026</idproveedor>
        <idfecha>20221228</idfecha>
        <exception></exception>
        <created_at>2022-12-28T20:26:18.000000Z</created_at>
        <updated_at>2022-12-28T20:26:18.000000Z</updated_at>
    </data>
</document>

Unauthenticated

Este error se da comunmente cuando el el token espiró

• title String Estado del resultado
• detail String Mensaje descriptivo del error
• status_code String Codigo de estado de la respuesta

{
  "errors": [
    {
      "title": "Unauthenticated",
      "detail": "The signature is invalid.",
      "status_code": "401"
    }
  ]
}

Bad Request

Mala peticion, la request presenta un error de estructura en la informacion enviadaSe recomienda verificar los headers

{
  "errors": [
    {
      "title": "Bad Request",
      "detail": "Error while decoding from Base64Url, invalid base64 characters detected",
      "status_code": 400
    }
  ]
}