Planificar un trayecto y calcular peajes

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/vale-pedagio/roteirizar

roteirizarValePedagioBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Calcula el recorrido por carretera entre origen y destino, identificando las plazas de peaje, las tarifas individuales según la cantidad de ejes indicada y los costos consolidados por modalidad de ruta (planejada, estendida y customizada).

Para definir el recorrido (una carretera específica o la ruta de su planificador), indique pontos_parada: ciudades o coordenadas intermedias en el orden del viaje. La operadora traza la ruta por esos puntos y devuelve las plazas; la compra (/vale-pedagio/comprar) utiliza las plazas de la ruta elegida, no su geometría.

Autenticación

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

`application/json`

CotarVpoRequest ↗

origemstringObligatorio

Código postal (con o sin guion) o nombre de ciudad/dirección de salida.

minLength3

maxLength150

destinostringObligatorio

Código postal (con o sin guion) o nombre de ciudad/dirección de llegada.

minLength3

maxLength150

eixosintegerObligatorio

Cantidad total de ejes del vehículo comercial o conjunto.

minimum2

maximum10

placastring | nullOpcional

Matrícula del vehículo comercial (formato Mercosur o brasileño antiguo).

maxLength10

modalidadestring | nullOpcional

Modalidad de ruta solicitada (planejada: ruta directa optimizada; estendida: ruta con tolerancia para desvíos; customizada: plazas específicas).

"planejada" · "estendida" · "customizada"

pontos_paradaarray | nullOpcional

Puntos intermedios del viaje, en el orden en que pasa el vehículo, entre origem y destino. La operadora no acepta una polilínea: la ruta se traza mediante puntos de parada. Cada punto puede ser una ciudad (cidade, en formato "Ciudad, Estado") o un par latitude/longitude en grados decimales (por ejemplo, vértices relevantes de un trazado propio). Si un punto incluye ciudad y coordenadas, prevalece la ciudad. Utiliza este campo para pasar por una carretera específica o reproducir la ruta de tu planificador. Sin este campo, la operadora elige el trayecto entre origen y destino.

VpoPontoParada ↗

maxItems20

tipo_rotastring | nullOpcional

Criterio de la operadora para trazar la ruta principal entre los puntos.

"mais_rapida" · "mais_curta"

Respuestas

200 Respuesta HTTP

Rutas y tarifas de peaje calculadas correctamente

`application/json`

CotarVpoResponse ↗

successbooleanOpcional

rotasarrayOpcional

RotaPedagio ↗

400 Respuesta HTTP

Solicitud inválida

`application/json`

Erro ↗

errorobjectOpcional

401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Respuesta HTTP

Ámbito no habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

429 Respuesta HTTP

Límite de solicitudes excedido (limite_requisicoes). Espera el intervalo indicado en el encabezado Retry-After antes de reintentar. Puede provenir del proveedor o del límite antiabuso de FleetPay, calculado por empresa autenticada y grupo de rutas, con una ventana corta para ráfagas y otra larga para tráfico automatizado lento. Los límites son amplios deliberadamente: las integraciones reales, incluidos lotes grandes procesados de una vez, deberían quedar muy por debajo. Si tu integración alcanza un límite, contacta con FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Respuesta HTTP

Error interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definición Completa de la Operación

{
  "tags": [
    "Vale-Pedágio (VPO)"
  ],
  "summary": "Roteirizar trajeto e calcular tarifas de pedágio",
  "operationId": "roteirizarValePedagio",
  "description": "Calcula o trajeto rodoviário entre origem e destino, identificando as praças de pedágio no percurso,\nvalores tarifários unitários para a quantidade de eixos informada e os custos consolidados por modalidade\nde rota (`planejada`, `estendida` e `customizada`).\n\nPara forçar o trajeto (rodovia específica, rota do seu roteirizador), informe `pontos_parada` — cidades\nou coordenadas intermediárias, na ordem da viagem. A operadora traça a rota por esses pontos e devolve as\npraças; a compra (`/vale-pedagio/comprar`) usa as praças da rota escolhida, não a geometria.\n",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CotarVpoRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Rotas e tarifas de pedágio calculadas com sucesso",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CotarVpoResponse"
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/Erro400"
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    },
    "500": {
      "$ref": "#/components/responses/Erro500"
    }
  },
  "method": "POST",
  "path": "/vale-pedagio/roteirizar",
  "parameters": []
}