Documentação
Introdução
Nossa equipe preza por oferecer aos seus clientes serviços confiáveis e de qualidade visando um alto ganho de produtividade. Pensando nisso, criamos a API Rotas Brasil
para permitir que suas aplicações possam integrar diretamente com o Rotas Brasil realizando os cálculos de custo de suas viagens.
Tenha em poucos segundos (até milissegundos) a distância, tempo e o quanto irá custar sua viagem (incluindo pedágio, combustível e tabela frete).
Para começar é simples, basta realizar o Login ou Cadastrar-se para ganhar 50 créditos
e testar qualquer serviço da nossa API. Cada requisição/consulta realizada com sucesso corresponde a 1 crédito.
Com o cadastro realizado, você irá ganhar um Token de acesso a nossa API, pois é através dele que você irá fazer suas requisições. Seu token está disponível no Perfil ou em qualquer lugar do sistema que estiver "SeuToken" (será substituído pelo mesmo, caso esteja logado).
Caso tenha qualquer dúvida sobre como utilizar a API, você pode entrar em Contato, que iremos te atender da melhor forma possível 😊.
Planilha Excel
Quando usar?
Caso não tenha uma equipe de TI em sua empresa ou não tenha conhecimento técnico para utilizar a API, não se preocupe. Pensando nisso, elaboramos uma planilha de fácil utilização para aumentar sua produtividade.
Como usar:
Veja como é simples, basta inserir seu token no campo "Token", preencher os dados na sessão "Entradas", clicar no botão "Consultar Rotas" e pronto. Nossa planilha irá se comunicar com a API e preencher a sessão "Resultados" automaticamente para você.
Coordenadas GET
Como fazer uma requisição?
Para realizar a requisição por coordenadas será utilizado o parâmetro pontos
, por meio dele será possível fornecer as coordenas de origem, destino e de pontos intermediários(se houver).
O valor do parâmetro pontos
deve seguir o seguinte formato: LongitudeOrigem
, LatitudeOrigem
; ... ; LongitudeDestino
, LatitudeDestino
Os pontos intermediários podem ser adicionados entre a origem e o destino, seguindo o padrão Longitude,Latitude;
.
EndPoints:
Parâmetros aceitos:
Token | Token do usuário em que deseja realizar a consulta. | Obrigatório |
Pontos | Coordenadas dos endereços. | Obrigatório |
Veiculo | Tipo do veículo no qual deseja consultar os valores dos pedágios. | Obrigatório *** |
Eixo | Quantidade de eixos do veículo a ser consultado. | Obrigatório *** |
Combustivel | Preço do combustível desejado para o cálculo do valor gasto de combustível no percurso. | Opcional |
Consumo | Quantos quilômetros o veículo faz por litro de combustível. | Opcional |
Paradas | Caso deseje que os endereços enviados para o cálculo da rota seja exibido na resposta. | Opcional *** |
Tabela | Tipo da tabela frete que deseja realizar o cálculo do frete mínimo. | Opcional *** |
Volta | Realiza o cálculo de ida e volta da rota. | Opcional |
UFs | Retorna todos os estados que a rota percorre. | Opcional |
RotaAlternativa | Retona rotas alternativas, caso existir(Não é garantido que retorne). | Opcional*** |
*** Caso não seja informado será considerado: veiculo = "auto"; eixo = 2; tabela = "a"; paradas = "false";rotaAlternativa = "false".
Valores dos parâmetros disponíveis:
Campo | Valores | Exemplo |
---|---|---|
pontos | Coordenadas geográficas | -46.6333824,-23.5506507; -49.2712724,-25.4295963 |
veiculo | String. Valores: auto, caminhao, onibus ou moto. | veiculo=auto |
eixo | Integer. Auto e Ônibus: 2 ≤ Integer ≤ 4. Caminhão 2 ≤ Integer ≤ 10 | veiculo=auto&eixo=2 |
combustivel | Float | combustivel=3.10 |
consumo | Float | consumo=10.00 |
paradas | Boolean | paradas=true |
tabela | String | tabela=a |
volta | Boolean | volta=true |
ufs | Boolean | ufs=true |
rotaAlternativa | Boolean | rotaAlternativa=true |
Exemplo de retorno de uma requisição:
{ "pesquisa": { "origem": "Curitiba, Paraná, BR.", "paradas": [ { "nome": "São Paulo, São Paulo, BR." } ], "destino": "Rio de Janeiro, Rio de Janeiro, BR." }, "rotas": [ { "creditoDisponivel": 49, "via": "Rodovia Régis Bittencourt, Rodovia Régis Bittencourt", "distancia": 833.88, "duracao": "11h2min", "veiculo": "caminhao", "eixos": "2", "valorPedagio": 163.40, "valorCombustivel": "Valor do combustível ou consumo não informado", "tabelaFrete": { "granelSolido": 1824.2566094970703, "granelLiquido": 1856.7346496582031, "frigorificada": 2172.651939331055, "conteinerizada": 0.0, "geral": 1817.9134934692383, "neoGranel": 1652.8052525024414, "perigosaGranelSolido": 2360.9960160522464, "perigosaGranelLiquido": 2416.3166282958987, "perigosaFrigorificada": 2588.373397338867, "perigosaConteinerizada": 0.0, "perigosaGeral": 2086.8705426635743, "perigosaGranelPressurizada": 0.0, "informacoes": { "tipoTabela": "A", "resolucao": "5.899", "data": "03/11/2020", "link": "https://www.in.gov.br/en/web/dou/-/portaria-n-399-de-3-de-novembro-de-2020-286403617?utm_campaign=circular_n_545_-_antt _atualiza_tabela_do_piso_minimo_de_frete&utm_medium=email&utm_source=RD+Station" } }, "pedagios": [ { "praca": "Campina Grande do Sul", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "57,200", "valor": 6.60, "distanciaOrigem": 41.45 }, { "praca": "Barra do Turvo", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "542,900", "valor": 6.60, "distanciaOrigem": 121.24 }, { "praca": "Cajati", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "485,700", "valor": 6.60, "distanciaOrigem": 176.39 }, { "praca": "Juquiá", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "426,600", "valor": 6.60, "distanciaOrigem": 233.31 }, { "praca": "Miracatu", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "370,400", "valor": 6.60, "distanciaOrigem": 287.58 }, { "praca": "São Lourenço da Serra", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "298,800", "valor": 6.60, "distanciaOrigem": 357.07 }, { "praca": "Raposo Tavares Interna", "concessionaria": "RODOANEL OESTE", "rodovia": "SP-021", "km": "24,700", "valor": 4.40, "distanciaOrigem": 382.26 }, { "praca": "Arujá N/S", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "204,500", "valor": 7.40, "distanciaOrigem": 438.09 }, { "praca": "Guararema N/S", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "180,000", "valor": 7.40, "distanciaOrigem": 460.01 }, { "praca": "Jacareí", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "165,000", "valor": 13.40, "distanciaOrigem": 477.34 }, { "praca": "Moreira César", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "88,000", "valor": 30.40, "distanciaOrigem": 555.56 }, { "praca": "Itatiaia", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "318,000", "valor": 30.40, "distanciaOrigem": 657.42 }, { "praca": "Viúva Graça", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "207,000", "valor": 30.40, "distanciaOrigem": 769.96 } ], "link": "https://rotasbrasil.com.br/?alternative=0&return=falsept0=-49.2712724%C-25.4295963&ptStop0=true&pt1=-46.6333824%C-23.5506507& ptStop1=true&pt2=-43.2093727%C-22.9110137&ptStop2=true&&veiculo=2&eixo=2&precoCombustivel=&consumo=" } ] }
Endereços GET
Como fazer uma requisição?
Para realizar a requisição por endereços será utilizado o parâmetros pontos
, por meio dele será possível fornecer os nomes das cidades de origem, destino e de pontos intermediários(se houver).
O valor do parâmetro pontos
deve seguir o seguinte formato: nomeCidadeOrigem
, nomeEstadoOrigem
; ... ; nomeCidadeDestino
, nomeEstadoDestino
Os pontos intermediários podem ser adicionados entre a origem e o destino, seguindo o padrão nomeCidadeOrigem,nomeEstadoOrigem;
.
EndPoints:
Parâmetros aceitos:
Token | Token do usuário em que deseja realizar a consulta. | Obrigatório |
Pontos | Coordenadas dos endereços. | Obrigatório |
Veiculo | Tipo do veículo no qual deseja consultar os valores dos pedágios. | Obrigatório *** |
Eixo | Quantidade de eixos do veículo a ser consultado. | Obrigatório *** |
Combustivel | Preço do combustível desejado para o cálculo do valor gasto de combustível no percurso. | Opcional |
Consumo | Quantos quilômetros o veículo faz por litro de combustível. | Opcional |
Paradas | Caso deseje que os endereços enviados para o cálculo da rota seja exibido na resposta. | Opcional *** |
Tabela | Tipo da tabela frete que deseja realizar o cálculo do frete mínimo. | Opcional *** |
Volta | Realiza o cálculo de ida e volta da rota. | Opcional |
UFs | Retorna todos os estados que a rota percorre. | Opcional |
RotaAlternativa | Retona rotas alternativas, caso existir(Não é garantido que retorne). | Opcional*** |
*** Caso não seja informado será considerado: veiculo = "auto"; eixo = 2; tabela = "a"; paradas = "false";rotaAlternativa = "false".
Valores dos parâmetros disponíveis:
Campo | Valores | Exemplo |
---|---|---|
pontos | Cidades e estados. | ponta grossa,parana; curitiba,parana |
veiculo | String. Valores: auto, caminhao, onibus ou moto. | veiculo=auto |
eixo | Integer. Auto e Ônibus: 2 ≤ Integer ≤ 4. Caminhão 2 ≤ Integer ≤ 10. | veiculo=auto&eixo=2 |
combustivel | Float | combustivel=3.10 |
consumo | Float | consumo=10.00 |
paradas | Boolean | paradas=true |
tabela | String | tabela=a |
volta | Boolean | volta=true |
ufs | Boolean | ufs=true |
rotaAlternativa | Boolean | rotaAlternativa=true |
Exemplo de retorno de uma requisição:
{ "pesquisa": { "origem": "-49.2712724,-25.4295963", "paradas": [ { "nome": "-46.6333824,-23.5506507" } ], "destino": "-43.2093727,-22.9110137" }, "rotas": [ { "creditoDisponivel": 49, "via": "Rodovia Régis Bittencourt, Rodovia Régis Bittencourt", "distancia": 833.88, "duracao": "11h2min", "veiculo": "caminhao", "eixos": "2", "valorPedagio": 163.40, "valorCombustivel": 1144.08, "tabelaFrete": { "granelSolido": 0.0, "granelLiquido": 0.0, "frigorificada": 0.0, "conteinerizada": 0.0, "geral": 0.0, "neoGranel": 0.0, "perigosaGranelSolido": 0.0, "perigosaGranelLiquido": 0.0, "perigosaFrigorificada": 0.0, "perigosaConteinerizada": 0.0, "perigosaGeral": 0.0, "perigosaGranelPressurizada": 0.0, "informacoes": { "tipoTabela": "D", "resolucao": "5.899", "data": "03/11/2020", "link": "https://www.in.gov.br/en/web/dou/-/portaria-n-399-de-3-de-novembro-de-2020-286403617?utm_campaign=circular_n_545_-_antt_atualiza_tabela_do_piso_minimo _de_frete&utm_medium=email&utm_source=RD+Station" } }, "pedagios": [ { "praca": "Campina Grande do Sul", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "57,200", "valor": 6.60, "distanciaOrigem": 41.45 }, { "praca": "Barra do Turvo", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "542,900", "valor": 6.60, "distanciaOrigem": 121.24 }, { "praca": "Cajati", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "485,700", "valor": 6.60, "distanciaOrigem": 176.39 }, { "praca": "Juquiá", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "426,600", "valor": 6.60, "distanciaOrigem": 233.31 }, { "praca": "Miracatu", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "370,400", "valor": 6.60, "distanciaOrigem": 287.58 }, { "praca": "São Lourenço da Serra", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "298,800", "valor": 6.60, "distanciaOrigem": 357.07 }, { "praca": "Raposo Tavares Interna", "concessionaria": "RODOANEL OESTE", "rodovia": "SP-021", "km": "24,700", "valor": 4.40, "distanciaOrigem": 382.26 }, { "praca": "Arujá N/S", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "204,500", "valor": 7.40, "distanciaOrigem": 438.09 }, { "praca": "Guararema N/S", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "180,000", "valor": 7.40, "distanciaOrigem": 460.01 }, { "praca": "Jacareí", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "165,000", "valor": 13.40, "distanciaOrigem": 477.34 }, { "praca": "Moreira César", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "88,000", "valor": 30.40, "distanciaOrigem": 555.56 }, { "praca": "Itatiaia", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "318,000", "valor": 30.40, "distanciaOrigem": 657.42 }, { "praca": "Viúva Graça", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "207,000", "valor": 30.40, "distanciaOrigem": 769.96 } ], "link": "https://rotasbrasil.com.br/?alternative=0&return=falsept0=-49.2712724%C-25.4295963&ptStop0=true& pt1=-46.6333824%C-23.5506507&ptStop1=true&pt2=-43.2093727%C-22.9110137&ptStop2=true&&veiculo=2&eixo=2&precoCombustivel=343&consumo=250" } ] }
CEP GET
Como fazer uma requisição?
Para realizar a requisição por CEP será utilizado o parâmetro pontos
, por meio dele será possível fornecer os CEPs dos endereços de origem, destino e de pontos intermediários(se houver).
O valor do parâmetro pontos
deve seguir o seguinte formato: cepOrigem
; ... ; cepDestino
Os pontos intermediários podem ser adicionados entre a origem e o destino, representado pelos ...
no exemplo acima.
EndPoints:
Parâmetros aceitos:
Token | Token do usuário em que deseja realizar a consulta. | Obrigatório |
Pontos | Código postal do endereço. | Obrigatório |
Veiculo | Tipo do veículo no qual deseja consultar os valores dos pedágios. | Obrigatório *** |
Eixo | Quantidade de eixos do veículo a ser consultado. | Obrigatório *** |
Combustivel | Preço do combustível desejado para o cálculo do valor gasto de combustível no percurso. | Opcional |
Consumo | Quantos quilômetros o veículo faz por litro de combustível. | Opcional |
Paradas | Caso deseje que os endereços enviados para o cálculo da rota seja exibido na resposta. | Opcional *** |
Tabela | Tipo da tabela frete que deseja realizar o cálculo do frete mínimo. | Opcional *** |
Volta | Realiza o cálculo de ida e volta da rota. | Opcional |
UFs | Retorna todos os estados que a rota percorre. | Opcional |
RotaAlternativa | Retona rotas alternativas, caso existir(Não é garantido que retorne). | Opcional*** |
*** Caso não seja informado será considerado: veiculo = "auto"; eixo = 2; tabela = "a"; paradas = "false";rotaAlternativa = "false".
Valores dos parâmetros disponíveis:
Campo | Valores | Exemplo |
---|---|---|
pontos | Cidades e estados | ponta grossa,parana; curitiba,parana |
veiculo | String. Valores: auto, caminhao, onibus ou moto. | veiculo=auto |
eixo | Integer. Auto e Ônibus: 2 ≤ Integer ≤ 4. Caminhão 2 ≤ Integer ≤ 10. | veiculo=auto&eixo=2 |
combustivel | Float | combustivel=3.10 |
consumo | Float | consumo=10.00 |
paradas | Boolean | paradas=true |
tabela | String | tabela=a |
volta | Boolean | volta=true |
ufs | Boolean | ufs=true |
rotaAlternativa | Boolean | rotaAlternativa=true |
Exemplo de retorno de uma requisição:
{ "pesquisa": { "origem": "Avenida Vicente Machado, Centro, Curitiba, Paraná. ", "paradas": [ { "nome": "Praça Antônio Prado, Centro, São Paulo, São Paulo. " } ], "destino": "Avenida Rio Branco, Centro, Rio de Janeiro, Rio de Janeiro. " }, "rotas": [ { "creditoDisponivel": 102, "via": "Rodovia Régis Bittencourt, Rodovia Régis Bittencourt", "distancia": 839.75, "duracao": "11h11min", "veiculo": "caminhao", "eixos": "2", "valorPedagio": 163.40, "valorCombustivel": "Valor do combustível ou consumo não informado", "tabelaFrete": { "granelSolido": 1835.67375, "granelLiquido": 1868.3455, "frigorificada": 2186.27385, "conteinerizada": 0.0, "geral": 1829.297175, "neoGranel": 1663.026675, "perigosaGranelSolido": 2375.484925, "perigosaGranelLiquido": 2431.0984500000004, "perigosaFrigorificada": 2604.4090499999998, "perigosaConteinerizada": 0.0, "perigosaGeral": 2099.690025, "perigosaGranelPressurizada": 0.0, "informacoes": { "tipoTabela": "A", "resolucao": "5.899", "data": "03/11/2020", "link": "https://www.in.gov.br/en/web/dou/-/portaria-n-399-de-3-de-novembro-de-2020-286403617?utm_campaign=circular_n_545_-_antt _atualiza_tabela_do_piso_minimo_de_frete&utm_medium=email&utm_source=RD+Station" } }, "pedagios": [ { "praca": "Campina Grande do Sul", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "57,200", "valor": 6.60, "distanciaOrigem": 43.92 }, { "praca": "Barra do Turvo", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "542,900", "valor": 6.60, "distanciaOrigem": 123.71 }, { "praca": "Cajati", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "485,700", "valor": 6.60, "distanciaOrigem": 178.86 }, { "praca": "Juquiá", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "426,600", "valor": 6.60, "distanciaOrigem": 235.78 }, { "praca": "Miracatu", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "370,400", "valor": 6.60, "distanciaOrigem": 290.05 }, { "praca": "São Lourenço da Serra", "concessionaria": "RÉGIS BITTENCOURT", "rodovia": "BR-116", "km": "298,800", "valor": 6.60, "distanciaOrigem": 359.54 }, { "praca": "Raposo Tavares Interna", "concessionaria": "RODOANEL OESTE", "rodovia": "SP-021", "km": "24,700", "valor": 4.40, "distanciaOrigem": 384.72 }, { "praca": "Arujá N/S", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "204,500", "valor": 7.40, "distanciaOrigem": 441.90 }, { "praca": "Guararema N/S", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "180,000", "valor": 7.40, "distanciaOrigem": 463.81 }, { "praca": "Jacareí", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "165,000", "valor": 13.40, "distanciaOrigem": 481.14 }, { "praca": "Moreira César", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "88,000", "valor": 30.40, "distanciaOrigem": 559.36 }, { "praca": "Itatiaia", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "318,000", "valor": 30.40, "distanciaOrigem": 661.22 }, { "praca": "Viúva Graça", "concessionaria": "NOVADUTRA*", "rodovia": "BR-116", "km": "207,000", "valor": 30.40, "distanciaOrigem": 773.76 } ], "link": "https://rotasbrasil.com.br/?alternative=0&return=falsept0=-49.2912399%C-25.4389025&ptStop0=true&pt1=-46.6345292%C-23.545579& ptStop1=true&pt2=-43.17732%C-22.90601&ptStop2=true&&veiculo=2&eixo=2&precoCombustivel=&consumo=" } ] }
Consulta saldo GET
Como fazer uma requisição?
Para consultar seu saldo, basta enviar o seu Token através do parâmetro token
. Essa requisição não consumira créditos, lembrando que qualquer consulta realizada nos demais serviços retornam seu saldo com a resposta da requisição.
EndPoints:
Perguntas frequentes
O token é sua chave de acesso para utilizar a API, sem ele não há como realizar consultas. Seu token está localizado na página documentação ou no perfil do usuário.
Cada consulta na API é equivalente a um crédito.
Exemplos de consultas:
Consulta | Parâmetro volta | Crédito gasto |
---|---|---|
São Paulo, SP -> Curitiba, PR | false | 1 |
São Paulo, SP -> Ponta Grossa, PR -> Curitiba, PR | false | 1 |
São Paulo, SP -> Curitiba, PR -> São Paulo, SP | false | 1 |
São Paulo, SP -> Curitiba | true | 1 |
São Paulo, SP -> Curitiba, PR -> São Paulo, SP | true | 1 |
Não! Prezamos por oferecer um serviço que traga ao usuário um alto índice de produtividade, portanto não há limite de consultas desde que haja créditos suficientes.