Roteirização de Pedágio


Previsão de calculo do valor total de pedágio para rota. Cada processamento resulta em um código de histórico único, e este deve ser utilizado no processo de integração de viagem caso desejar efetuar a compra do pedágio.

Tipos de Rota:

  • Mais curta (THE_SHORTEST): Vai calcular a rota pela distancia de KmTotal mais curta.
  • Mais Rapida (THE_FASTEST): Vai calcular a rota pelo TempoPrevisto mais rapido.

Quando nao informado o campo TipoRota, o valor padrao utilizado para calcular a rota é mais rapido (THE_FASTEST).


Request


Índice Chave Descrição Elem. Tipo Ocor. Tamanho Versão
1 CNPJAplicacao CNPJ da Aplicação para autenticação E Caractere 1-1 14 1.0
2 Token Gerado a partir do CNPJ de autenticação para validar permissões de acesso E Caractere 1-1 100 1.0
3 DocumentoUsuarioAudit Documento do usuário que está realizando a operação E Caractere 1-1 14 1.0
4 NomeUsuarioAudit Nome do usuário que está realizando a operação E Caractere 1-1 60 1.0
5 CNPJEmpresa CNPJ da Empresa para autenticação (mesmo CNPJAplicacao) E Caractere 1-1 14 1.0
6 TipoVeiculo Tipo de veículo para calcular valores da rota. Enviar “Caminhao”:
0: Carro
1: Motocicleta
2: Ônibus
3: Caminhão		 E Inteiro 1-1 1 1.0
7 QtdEixos Quantidade de eixos do veículo E Inteiro 1-1 2 1.0
8 ExibirDetalhes Enviar sempre TRUE (default TRUE) E Boolean 1-0 True/False 1.0
9 Billing Billing E Caractere 1-0 50 1.8
10 TipoRota Enum de tipo de rota para calcular valores da rota. Pode ser:
0: THE_FASTEST (padrão quando não informado)
1: THE_SHORTEST		 E Inteiro 1-0 1 1.0
11 Localizacoes Lista com até 20 pontos de passagem do veículo para cálculo da rota.
São obrigatórios ao menos 2 pontos e podem ser adicionados até 18 pontos intermediários para aumentar a precisão da rota calculada, deixando-a o mais coerente possível com o TMS da transportadora cliente.
A rota é calculada respeitando a ordem da lista indicada: primeiro ponto = partida, último ponto = destino.		 A 1-1 1.0
11.1 IbgeCidade Código IBGE da cidade OU E Inteiro 1-1 7 1.0
11.2 Latitude Latitude do local (exemplo: -29.8008) E Decimal 1-0 10.8 1.0
11.3 Longitude Longitude do local (exemplo: -47.1001) OU E Decimal 1-0 10.8 1.0
11.4 IdRotaModelo Consulta custo de rota baseado em rota previamente cadastrada para o cliente E Inteiro 1-0 10 1.0
11.5 NomeRota Nome da rota E Caractere 1-0 100 1.0
12 TipoRodagem Tipo de rodagem: 1 = Simples, 2 = Duplo Importante para definição de valores na roterização E Enum 1-0 1 1.0 


{
  "CNPJAplicacao": "",
  "CNPJEmpresa": "",
  "Token": "",
  "TipoVeiculo": 1,
  "QtdEixos": 0,
  "ExibirDetalhes": true,
  "Billing": "",
  "TipoRota": 1,
  "TipoRodagem" : 1,
  "Localizacoes": [
    {
      "IbgeCidade": ""
      "Latitude": 0.0,
      "Longitude": 0.0,
      "IdRotaModelo": 0,
      "NomeRota": ""
    },
  ]
}


Response


Índice Chave Descrição Elem. Tipo Ocor. Tamanho Versão
1 Sucesso Enum do Status do processamento:
0: Falha,
1: Sucesso		 E Inteiro 1-1 1 1.0
2 Mensagem Mensagem de retorno E Caractere 1-1 100 1.0
3 CustoTotal Valor total do percurso solicitado E Inteiro 1-1 10 1.0
4 CustoTotalTAG Valor total do percurso solicitado com desconto concedido nas concessionárias (acordo comercial entre TAG e concessionarias) E Inteiro 1-1 10 1.0
5 IdentificadorHistorico Código único que identifica a roteirização. No processo de integração da viagem, para efetivar a compra do pedágio, é necessário enviar esta informação no objeto “Pedágio” E GUID 1-1 40 1.0
6 KmTotal Quilometragem (Km) total da rota E Decimal 1-1 40 1.0
7 TempoPrevisto Tempo total da rota E Caractere 1-1 HH:mm:ss 1.0
8 Localizacoes Localizações da rota A 1-1
8.1 cidade Nome da cidade com todas letras em maiusculo E Caractere 0-1 100 1.0
8.2 estado Sigla do estado com todas letras em maiusculo E Caractere 0-1 2 1.0
8.3 pais Nome do País com todas letras em maiusculo E Caractere 0-1 100 1.0
9 Pracas Lista de praças A 1-1
9.1 nome Nome da praça de pedágio E Caractere 1-1 200 1.0
9.2 telefone Telefone de contado E Caractere 0-1 20 1.0
9.3 enderecoDescricao Endereço da Praça de Pedágio E Caractere 0-1 200 1.0
9.4 concessao Concessionaria / Concessão E Caractere 0-1 200 1.0
9.5 codigoAntt Código da ANTT referente a praça E Inteiro 1-1 10 1.0
9.6 viaFacilId ID do Via Facil E Inteiro 1-1 10 1.0
9.7 fragmentoIndex Indexador E Inteiro 1-1 10 1.0
9.8 localizacao Localização da praça G 1-1
9.8.1 latitude Coordenada geográfica da praça de pedágio E Decimal 0-1 11,8 1.0
9.8.2 longitude Coordenada geográfica da praça de pedágio E Decimal 0-1 11,8 1.0
9.9 precos Lista de preços do pedágio. Para o Brasil sempre A 1-1
9.9.1 precoEixoAdicional Valor Eixo Adicional E Decimal 1-1 10,2 1.0
9.9.2 valor Valor total a ser pago para a quantidade de eixos requisitada E Decimal 1-1 10,2 1.0
9.9.3 valorTAG Valor total a ser pago para a quantidade de eixos requisitada, valor TAG com desconto , se concedido pela concessionária E Decimal 1-1 10,2 1.0
9.9.4 TabelaFrete Objeto com o valor do piso minimo de frete E Decimal 1-1 10,2 1.0
9.9.4.1 Valor Campo decimal de retorno do valor do piso minimo de frete E Decimal 1-1 10,2 1.0


Modelo de Json - Response


Modelo de Json - Response


{
  "Status": 0,
  "Mensagem": null,
  "CustoTotal": 0.0,
  "CustoTotalTag": 0.0,
  "IdentificadorHistorico": "",
  "KmTotal": 0,
  "TempoPrevisto": "00:00:00",
  "Localizacoes": [
    {
      "cidade": "",
      "estado": "",
      "pais": ""
    }
  ],
  "Pracas": [
    {
      "nome": "",
      "localizacao": {
        "latitude": "",
        "longitude": ""
      },
      "telefone": "",
      "enderecoDescricao": "",
      "concessao": "",
      "codigoAntt": "",
      "viaFacilId": "",
      "fragmentoIndex": 0,
      "precos": [
        {
          "precoEixoAdicional": 0.0,
          "valor": 0.0,
          "valorTag": 0.0
        }
      ]
    }
  ],
  "TabelaFrete": {
    "Valor": 0.0
  }
}


Calculo de Piso Minimo de Frete


Este método também permite realizar o calculo do piso minimo de frete através do objeto TabelaFrete no payload da requisição.


Índice Chave Descrição Elem. Tipo Ocor. Tamanho Versão
10 TabelaFrete Objeto com os dados utilizados para calculo do piso minimo de frete G 1-1 1.0
10.1 RetornoVazio Indica se a viagem considera retorno vazio / ida e volta E Boolean 1-1 True/False 1.0
10.2 Carga Tipo de carga considerada para calculo do piso minimo. Pode ser nulo. Valores aceitos:
0: GRANEL_SOLIDO;
1: GRANEL_LIQUIDO;
2: FRIGORIFICADA_OU_AQUECIDA;
3: CONTEINERIZADA;
4: CARGA_GERAL;
5: NEOGRANEL;
6: PERIGOSA_GRANEL_SOLIDO;
7: PERIGOSA_GRANEL_LIQUIDO;
8: PERIGOSA_FRIGORIFICADA_OU_AQUECIDA;
9: PERIGOSA_CONTEINERIZADA;
10: PERIGOSA_CARGA_GERAL;
11: GRANEL_PRESSURIZADA.		 E Inteiro 1-1 2 1.0
10.3 ComposicaoVeicular Indica se o veículo considerado é composição veicular. Refere-se ao cenário de veículo automotor + implemento, em contraste com caminhão simples E Boolean 1-1 True/False 1.0
10.4 AltoDesempenho Refere-se a transportes com tempo total de carga e descarga de até 3 horas, exigindo agilidade e contrato específico E Boolean 1-1 True/False 1.0


Observações importantes de Uso:

  1. Para o calculo do piso minimo, os números de eixos aceitos são: 2, 3, 4, 5, 6, 7 e 9.
  2. Caso o veículo possua 8 ou 10 eixos, será utilizado um eixo a menos de acordo com as regras da calculadora da ANTT.
  3. Exemplo: veículo com 8 eixos -> o sistema irá calcular com 7 eixos.
  4. Exemplo: veículo com 10 eixos -> o sistema irá calcular com 9 eixos.
  5. Caso o calculo pela API seja realizado com retorno_vazio = true, para conferência na calculadora da ANTT o cliente deve dividir por 2 a distância retornada na API, conforme regra da calculadora da ANTT.
  6. Importante também: caso retorno_vazio = true, devem ser passadas as localizações de ida e volta, caso contrário não será possível realizar a roteirização.
  7. As localizações devem ser exatamente iguais quando se tratar de ida e volta. ex: IBGE cidade ou latitude e longitude. Para que o calculo seja assertivo.


## Modelo de Json - Request com TabelaFrete 
{
  "Token": "687cba85c89b57219cfc187a0b38aa79",
  "CNPJAplicacao": "12345678901234",
  "CNPJEmpresa": "12345678901234",
  "TipoVeiculo": 3,
  "TipoRodagem": 2,
  "QtdEixos": 10,
  "ExibirDetalhes": true,
  "Localizacoes": [
    {
      "IdRotaModelo": 1647
    }
  ],
  "TabelaFrete": {
    "RetornoVazio": false,
    "Carga": null,
    "ComposicaoVeicular": false,
    "AltoDesempenho": false
  }
}