Roteirizar trajeto e calcular tarifas de pedágio

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/vale-pedagio/roteirizar

roteirizarValePedagioBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Calcula o trajeto rodoviário entre origem e destino, identificando as praças de pedágio no percurso, valores tarifários unitários para a quantidade de eixos informada e os custos consolidados por modalidade de rota (planejada, estendida e customizada).

Para forçar o trajeto (rodovia específica, rota do seu roteirizador), informe pontos_parada — cidades ou coordenadas intermediárias, na ordem da viagem. A operadora traça a rota por esses pontos e devolve as praças; a compra (/vale-pedagio/comprar) usa as praças da rota escolhida, não a geometria.

Autenticação

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

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

`application/json`

CotarVpoRequest ↗

origemstringObrigatório

CEP (com ou sem hífen) ou nome da cidade/endereço de partida.

minLength3

maxLength150

destinostringObrigatório

CEP (com ou sem hífen) ou nome da cidade/endereço de chegada.

minLength3

maxLength150

eixosintegerObrigatório

Quantidade total de eixos do veículo comercial ou conjunto.

minimum2

maximum10

placastring | nullOpcional

Placa do veículo comercial (padrão Mercosul ou antigo).

maxLength10

modalidadestring | nullOpcional

Modalidade de rota pretendida (planejada: rota direta otimizada; estendida: rota com tolerância para desvios; customizada: praças específicas).

"planejada" · "estendida" · "customizada"

pontos_paradaarray | nullOpcional

Pontos intermediários da viagem, na ordem em que o veículo passa, entre origem e destino. A operadora não aceita polyline: a rota é traçada por pontos de parada, e cada ponto pode ser uma cidade (cidade, no formato "Cidade, UF") ou um par latitude/longitude em graus decimais (vértices relevantes de um traçado próprio, por exemplo). Se um ponto trouxer cidade e coordenadas, vale a cidade. Use-o para forçar o trajeto por uma rodovia específica ou reproduzir a rota do seu roteirizador. Sem este campo a operadora escolhe o trajeto entre origem e destino.

VpoPontoParada ↗

maxItems20

tipo_rotastring | nullOpcional

Critério da operadora para traçar a rota principal entre os pontos.

"mais_rapida" · "mais_curta"

Respostas

200 Resposta HTTP

Rotas e tarifas de pedágio calculadas com sucesso

`application/json`

CotarVpoResponse ↗

successbooleanOpcional

rotasarrayOpcional

RotaPedagio ↗

400 Resposta HTTP

Requisição inválida

`application/json`

Erro ↗

errorobjectOpcional

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Escopo não habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Resposta HTTP

Erro interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "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": []
}