API: Data Forwarding Rules (Webhooks)

M: Listar Reglas de Reenvío de Información (Webhooks)

HTTP GET:

https://<hostname>/api/data-forwarding-rules

OUTPUT:

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/data-forwarding-rules

RESPUESTA:

{
    "success": true,
    "data": {
        "500": {
            "client_id": "2",
            "vehicle_ids": [
                "232",
                "234",
                "237",
                "238"
            ],
            "vehicle_group_ids": [
                "15",
                "16"
            ],
            "format": "startrack",
            "destination_url": "http://third-party.server.net"
        },
        "501": {
            "client_id": "3",
            "vehicle_ids": [],
            "vehicle_group_ids": [
                "31",
                "32",
                "33"
            ],
            "format": "startrack",
            "destination_url": "http://third-party.server.net"
        }
    }
}

M: Crear Regla de Reenvío de Información (Webhook)

HTTP POST:

https://<hostname>/api/data-forwarding-rules

BODY PARAMETERS:

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     --data "client_id=3vehicle_group_ids=38,39&format=startrack
             &destination_url=http://third-party.server.net"
     https://<hostname>/api/data-forwarding-rules

RESPUESTA:

{
    "success": true,
    "data": {
        "client_id": "3",
        "vehicle_ids": [],
        "vehicle_group_ids": [
            "38",
            "39"
        ],
        "format": "startrack",
        "destination_url": "http://third-party.server.net"
    }
}

M: Eliminar Regla de Reenvío de Información (Webhook)

HTTP PUT:

https://<hostname>/api/data-forwarding-rules/<id>

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X DELETE
     https://<hostname>/api/data-forwarding-rules/511

RESPUESTA:

{
    "success": true
}

O: Data Forwarding Rule object

Campo Descripción
client_id Id del cliente del que se quiere reenviar los datos
vehicle_ids Ids de los vehículos de los que se quiere reenviar los datos. Números separados por coma (,)
vehicle_group_ids Ids de los grupos de vehículos de los que se quiere reenviar los datos. Números separados por coma (,)
format Formato en el que se quiere recibir la información. Opciones: startrack, dct
destination_url Url a la que se debe reenviar los datos