Consultar praças por polyline

Permite que o cliente consulte as praças de pedágio disponíveis a partir de uma polyline criptografada. Esse endpoint utiliza os dados da polyline, juntamente com uma configuração do veículo (tipo e número de eixos), para retornar uma lista de pedágios com informações relevantes, como código, nome e tarifa (com desconto aplicado, quando houver).

Método e rota

• Criação (POST): /valePedagio/consultaPracasPolyline/{enterpriseID}

Estrutura da requisição

Cabeçalhos

• Authorization: o token JWT deve ser enviado no header.

  Authorization: Bearer {token}

Corpo

O payload JSON enviado deve obedecer esta estrutura. Confira o exemplo abaixo:

{
  "polyline": {
    "string": "encrypted_polyline_string",
    "precision": "5" // "5" para modelo Google, "6" para outros mais precisos
  },
  "config": {
    "vehicle": {
      "type": "truck", // Utilizar "truck" ou "car"
      "axis": "6"
    }
  }
}

Layout

Nome do campo	Tipo	Observação
polyline	objeto	Objeto que contém a informação da linha (path) criptografada.
└─ string	string	Obrigatório. Polyline criptografada que representa o caminho a ser analisado.
└─ precision	string	Obrigatório. Define a precisão usada na decodificação da polyline ("5" para padrão Google ou "6" para maior precisão).
config	objeto	Objeto que contém configurações adicionais.
└─ vehicle	objeto	Define dados do veículo para a consulta.
└─ type	string	Obrigatório. Tipo de veículo. Valores possíveis: "truck" ou "car".
└─ axis	string	Obrigatório. Número de eixos do veículo.

Validações e regras de negócio

1. Envio da requisição (POST /valePedagio/consultaPracasPolyline):

   • O cliente envia o JSON com a polyline e as configurações do veículo.
   • O servidor processa a polyline, decodifica-a conforme a precisão especificada e realiza a consulta das praças de pedágio compatíveis com o caminho e o tipo de veículo.

2. Resposta:

   • Se a consulta for bem-sucedida, o servidor retorna o array de pedágios com suas respectivas informações. Se houver erro, o servidor retorna um JSON contendo o código e a mensagem de erro.

Resposta do POST

Após o processamento da consulta, a API retornará um JSON com os seguintes dados:

Exemplo de resposta bem-sucedida:

{
  "pedagios": [
    {
      "codigo_antt": "35011162045000103",
      "nome": "Arujá N/S",
      "tarifa": 26.4
    }
  ]
}

Nome do campo	Tipo	Observação
pedagios	array	Array contendo os pedágios retornados pela consulta. Cada item representa uma praça de pedágio.
└─ codigo_antt	string	Código identificador do pedágio conforme cadastro na ANTT.
└─ nome	string	Nome da praça de pedágio.
└─ tarifa	number	Valor da tarifa, já com o desconto básico de tarifa (DBT) aplicado, quando houver.

Exemplo de resposta de erro

Caso ocorra uma falha na consulta (por exemplo, devido a dados inválidos na polyline ou problemas com a configuração do veículo), o response seguirá o padrão de erro:

{
  "codigo": "400",
  "mensagem": "Erro na validação dos parâmetros da polyline."
}

Códigos de Status HTTP

• 200 ou 201: Retorna quando a consulta é realizada com sucesso e os dados dos pedágios são retornados conforme o exemplo.
• 400: Erro de validação (por exemplo, parâmetros ausentes ou com formato incorreto).
• 401: Não autorizado (token JWT ausente ou inválido).
• 500: Erro interno do servidor ou exceções não tratadas.