Toll

Estructura de respuesta – Endpoint independiente

En este ejemplo, tenemos una ruta simple que pasa por el peaje de Itaquaquecetuba. Utilizaremos el endpoint independiente para calcular los peajes.

Solicitud

El parámetro legs es una array de objetos donde cada objeto representa una sección de la ruta. En cada leg, debemos definir el parámetro points, que contiene las coordenadas que componen la ruta. En este caso, sólo tenemos un leg que corresponde a toda la ruta.

En vehicleType hemos decidido que queremos hacer la ruta con un camión de doble eje,
TRUCK_WITH_TWO_DOUBLE_AXLES
. En condition, informaremos el billingType como NORMAL y el period como NORMAL.

Si utiliza la Trip API, la respuesta obtenida de Trip puede utilizarse como solicitud a la Toll API, simplemente añadiendo el parámetro vehicleType a cada leg.

Nota: El endpoint independiente sólo se recomienda si utiliza routers de terceros. Si utiliza la Trip API, puede obtener los peajes en la misma solicitud.

A continuación figura la solicitud completa:

{
    "legs": [
        {
            "points": [
                {
                    "latitude": -23.465395,
                    "longitude": -46.375007
                },
                {
                    "latitude": -23.465957,
                    "longitude": -46.371015
                },
                {
                    "latitude": -23.467154,
                    "longitude": -46.36559
                }
            ],
            "vehicleType": "TRUCK_WITH_TWO_DOUBLE_AXLES",
            "condition": {
                "period": "NORMAL",
                "billingType": "NORMAL"
            }
        }
    ]
}

Respuesta

En la respuesta tendremos los siguientes campos:

  • totalCost – Valor total del peaje en todo el recorrido;
  • legs – Array de objetos donde cada objeto representa un tramo de la ruta. Cada leg de la respuesta corresponde a un leg  de la solicitud. Se devolverán los siguientes campos en cada objeto:
    • tolls – Objeto con los valores e información de cada peaje en el tramo correspondiente. Cada objeto devuelto en tolls representa un peaje y contendrá la siguiente información::
      • name – Nombre del peaje;
      • address – Dirección de peaje;
      • city – Ciudad de peaje;
      • state – Objeto que contiene el nombre del Estado (name) y su acrónimo (code);
      • country – País de peaje;
      • concession – Concesionario responsable del peaje;
      • coordinates – Coordenadas (latitud y longitud) del peaje;
      • price – Precio por peaje;
      • serviceTypes – Array con códigos para la integración con sistemas de pago automático. Actualmente sólo está disponible en Brasil
        • serviceId – Código para la integración;
        • name – Descripción del código de servicio.
    • legTotalCost – Costo total del peaje para la sección;
    • vehicleType – Tipo de vehículo considerado para el tramo;
    • calculationDate – Fecha y hora consideradas para el tramo, en formato de timestamp;
    • condition – Si se utiliza el parámetro condition en la solicitud, se devolverá este objeto que contiene el billingType y period se consideraron para el tramo.

A continuación encontrará la respuesta completa:

{
    "legs": [
        {
            "tolls": [
                {
                    "id": "17",
                    "name": "Pedágio - Itaquaquecetuba Leste",
                    "address": "SP 070 - Rod. Ayrton Senna - Km 32,9",
                    "city": "Itaquaquecetuba",
                    "state": {
                        "name": "São Paulo",
                        "code": "SP"
                    },
                    "country": "Brasil",
                    "concession": "Ecopistas",
                    "direction": "EAST",
                    "coordinates": {
                        "latitude": -23.4656821,
                        "longitude": -46.3727036
                    },
                    "serviceTypes": [
                        {
                            "serviceId": "80",
                            "name": "Via Facil"
                        },
                        {
                            "serviceId": "35350700329000103",
                            "name": "ANTTCODE"
                        }
                    ],
                    "price": 10.80
                }
            ],
            "legTotalCost": 10.80,
            "vehicleType": "TRUCK_WITH_TWO_DOUBLE_AXLES",
            "condition": {
                "billingType": "NORMAL",
                "period": "NORMAL"
            },
            "calculationDate": 1738852668146
        }
    ],
    "totalCost": 10.80
}