Documentação rápida da API Distance Matrix

Diretrizes para desenvolvedores
Antes de começar
É um serviço de API HTTP projetado para calcular todas as combinações possíveis entre o ponto de partida e o destino e permite obter esses dados em segundos e metros. O Distance Matrix API Fast está disponível em qualquer lugar do mundo e garante um nível similar de precisão e resposta com os melhores análogos, como a API de matriz de distância do Google. O melhor resultado que você pode obter para o idioma inglês.

Nesta documentação do Distance Matrix API Fast, você pode encontrar uma introdução ao uso do produto e material de referência sobre os parâmetros disponíveis.

O que você pode fazer com o Distance Matrix API Fast?

Este produto garante aos desenvolvedores um cálculo do tempo de viagem e da distância entre alguns pontos. Portanto, é mais valioso para empresas que priorizam o tempo de resposta em vez de dados altamente precisos, que operam em setores dinâmicos e urgentes, onde a rápida tomada de decisões e a otimização de rotas são essenciais. Portanto, ele pode ser usado para diferentes tipos de serviços de entrega e correio, como entrega de alimentos, mercadorias e medicamentos, serviços de compartilhamento de caronas, logística, etc.

Empresas que enviam técnicos ou pessoal de serviço para os locais dos clientes, como empresas de reparo de HVAC ou prestadores de serviços a cabo, se beneficiam de tempos de resposta rápidos para agendar consultas com eficiência e notificar os clientes sobre os horários de chegada.

As empresas que exigem tempos de resposta rápidos e precisos com a API Distance Matrix também incluem serviços de emergência, serviços sob demanda, varejo, viagens, gerenciamento de frotas e iniciativas de cidades inteligentes. O acesso rápido aos dados de distância é crucial para otimizar rotas, minimizar atrasos e aprimorar a experiência do cliente nesses setores urgentes.

Por que você deve usar o Distance Matrix API Fast?

Você pode usar nosso produto para encontrar o ponto de destino mais próximo do ponto de origem ou para qualquer outra finalidade. A API retornará a duração e a distância na rota mais rápida ou mais curta de cada elemento. Por sua vez, cada elemento é um par origem-destino.

Essa solução funciona em todo o mundo e está disponível somente para o modo de direção.

Se o tráfego em tempo real não afetar significativamente seus negócios, você poderá economizar tempo e aumentar o desempenho do produto usando o Distance Matrix API Fast. Para grandes volumes de cálculo, você pode considerar nossa API de matriz de distância assíncrona.
Se a precisão dos dados e o tráfego em tempo real são mais valiosos para sua empresa, você deve verificar nossa solução - API de matriz de distância precisa.

Como você deve usar o Distance Matrix API Fast?

Você fornece dados de entrada (endereços ou coordenadas) para os quais deseja fazer uma estimativa. Você receberá uma resposta no formato JSON e a resposta conterá informações sobre a duração média de cada seção de rota construída. O tempo de viagem calculado para uma seção da rota não leva em conta as condições atuais do tráfego.

Por exemplo, há três locais iniciais A, B e C e três locais de destino E, B e D. O Distance API Fast retorna a matriz de durações em segundos/minutos e distâncias em metros/quilômetros entre os locais. Ele não retorna geometrias de rota.
origens\ destinos
E
B
D
UM
A a E
A a B
A a D
B
B a E
B a B = 0
B a D
C
C a E
C a B
C a D
O tempo e a distância entre os pontos podem não ser simétricos, pois as rotas podem diferir de acordo com a direção devido a ruas de mão única ou restrições de curva. Por exemplo, A a B pode ter uma duração diferente de B a A.

As seções a seguir fornecem informações mais detalhadas com base nos exemplos da API Distance Matrix.

Parâmetros de solicitação

A solicitação rápida da API Distance Matrix foi criada especificamente para ser semelhante ao formato de solicitação da API Distance Matrix do Google. Você pode obter mais informações sobre o Migrar para a API Distancematrix.ai página.
Uma solicitação rápida da API Distance Matrix tem o seguinte formato:
OBTENHA:
https://api-v2.distancematrix.ai/maps/api/distancematrix/json?origins=<origin_location_1|origin_location_2|...|origin_location_n>&destinations=<destination_location_1|destination_location_2|...|destination_location_n>&key=<your_access_token>
Copiado!
Um exemplo de solicitação da API Distance Matrix:
OBTENHA:
https://api-v2.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&key=<your_access_token>
Copiado!

Parâmetros necessários

origens — um ponto de partida para calcular a distância e o tempo de viagem. Você pode fornecer um ou mais locais separados pelo caractere vertical (|) na forma de um endereço ou coordenadas de latitude/longitude:
1. Se você passar um endereço, o serviço geocodifica a string e a converte em uma coordenada de latitude/longitude para calcular a distância. Essa coordenada pode ser diferente daquela retornada pela API de Geocodificação, por exemplo, a entrada de um prédio em vez de seu centro.
Mostrar exemplo
Ocultar exemplo
Exemplo de solicitação com endereços:
OBTENHA:
https://api-v2.distancematrix.ai/maps/api/distancematrix/json?origins=Westminster Abbey, 20 Deans Yd, Westminster, London SW1P 3PA, United Kingdom&destinations=St John's Church, North End Rd, Fulham, London SW6 1PB, United Kingdom&key=<your_access_token>
Copiado!
Resposta
CORPO
{
    "destination_addresses": [
        "St John's Church, North End Rd, London SW6 1PB, United Kingdom"
    ],
    "origin_addresses": [
        "Westminster Abbey, 20 Deans Yd, London SW1P 3PA, United Kingdom"
    ],
    "rows": [
        {
            "elements": [
                {
                    "distance": {
                        "text": "7.3 km",
                        "value": 7346
                    },
                    "duration": {
                        "text": "23 mins",
                        "value": 1401
                    },
                    "origin": "Westminster Abbey, 20 Deans Yd, Westminster, London SW1P 3PA, United Kingdom",
                    "destination": "St John's Church, North End Rd, Fulham, London SW6 1PB, United Kingdom",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copiado!
2. Se você passar as coordenadas de latitude/longitude, elas serão usadas inalteradas para calcular a distância. Certifique-se de que não haja espaço entre os valores de latitude e longitude.
Mostrar exemplo
Ocultar exemplo
Exemplo de solicitação com coordenadas:
OBTENHA:
https://api-v2.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&key=<your_access_token>
Copiado!
Resposta
CORPO
{
   "destination_addresses": [
       "Westminster Abbey, London SW1P 3PA, UK"
   ],
   "origin_addresses": [
       "Chapel, London SW6 1BA, UK"
   ],
   "rows": [
       {
           "elements": [
               {
                   "distance": {
                       "text": "7.6 km",
                       "value": 7567
                   },
                   "duration": {
                       "text": "22 mins",
                       "value": 1359
                   },
                   "origin": "51.4822656,-0.1933769",
                   "destination": "51.4994794,-0.1269979",
                   "status": "OK"
               }
           ]
       }
   ],
   "status": "OK"
}
Copiado!
  • destinos — um ou mais locais a serem usados como destino final para calcular a distância e o tempo de viagem. As opções para o parâmetro de destino são as mesmas do parâmetro original, conforme descrito acima.
  • key — a chave de API do seu aplicativo.

Parâmetros opcionais

Caso você esteja interessado em usar parâmetros opcionais; modos de dirigir, caminhar e andar de bicicleta; dados de tráfego em tempo real, evitando rodovias, balsas e ambientes fechados, escolha outro produto, Distance Matrix API Accurate. Para obter mais informações, sinta-se à vontade para verificar sua documentação.

Exemplo de resposta

A resposta contém uma matriz de objetos de linhas, cada linha contendo uma origem emparelhada com cada destino. Cada elemento do objeto na matriz contém as propriedades de uma única variante de rota. Para obter uma descrição detalhada dos elementos, consulte a seção Elementos de resposta da matriz de distância.
Resposta
CORPO
{
   "destination_addresses": [
       "Westminster Abbey, London SW1P 3PA, UK"
   ],
   "origin_addresses": [
       "Chapel, London SW6 1BA, UK"
   ],
   "rows": [
       {
           "elements": [
               {
                   "distance": {
                       "text": "7.6 km",
                       "value": 7567
                   },
                   "duration": {
                       "text": "22 mins",
                       "value": 1359
                   },
                   "origin": "51.4822656,-0.1933769",
                   "destination": "51.4994794,-0.1269979",
                   "status": "OK"
               }
           ]
       }
   ],
   "status": "OK"
}
Copiado!

Elementos de resposta da matriz de distância

As respostas da Matriz de Distância contêm os seguintes elementos raiz:
  • status contém metadados sobre a solicitação. Veja Códigos de status abaixo.
  • origin_addresses contêm uma matriz de endereços conforme retornados pela API de sua solicitação original. Eles são formatados pelo geocodificador e localizados de acordo com o parâmetro de idioma passado com a solicitação.
  • destination_addresses contêm uma matriz de endereços retornados pela API a partir de sua solicitação inicial. Assim como os endereços de origem, eles são localizados, se apropriado.
  • as linhas contêm uma matriz de elementos, que por sua vez contêm elementos de status, duração e distância.

Códigos de status

Os campos de status no objeto de resposta contêm o status da solicitação e podem conter informações úteis de depuração. A API Distance Matrix retorna um campo de status de nível superior com informações sobre a solicitação em geral, bem como um campo de status para cada campo de elemento com informações sobre esse emparelhamento específico de origem e destino.

Códigos de status de nível superior

  • OK indica que a resposta contém um resultado válido.
  • INVALID_REQUEST indica que a solicitação fornecida era inválida.
  • MAX_ELEMENTS_EXCEEDED indica que o produto de origem e destino excede o limite por consulta.
  • OVER_DAILY_LIMIT indica qualquer um dos seguintes:
    • A chave da API está ausente ou é inválida.
    • O faturamento não foi ativado em sua conta.
    • Um limite de uso autoimposto foi excedido.
    • O método de pagamento fornecido não é mais válido (por exemplo, um cartão de crédito expirou).
  • OVER_QUERY_LIMIT indica que o serviço recebeu muitas solicitações do seu aplicativo dentro do período permitido.
  • REQUEST_DENIED indica que o serviço negou o uso do serviço Distance Matrix pelo seu aplicativo.
  • UNKNOWN_ERROR indica que uma solicitação do Distance Matrix não pôde ser processada devido a um erro no servidor. A solicitação poderá ser bem-sucedida se você tentar novamente.

Códigos de status em nível de elemento

  • OK indica a resposta e contém um resultado válido.
  • NOT_FOUND indica que a origem e/ou o destino desse emparelhamento não puderam ser geocodificados.
  • ZERO_RESULTS indica que nenhuma rota foi encontrada entre a origem e o destino.
  • MAX_ROUTE_LENGTH_EXCEEDED indica que a rota solicitada é muito longa e não pode ser processada.
  • UNKNOWN_ERROR indica que uma solicitação do Distance Matrix não pôde ser processada devido a um erro no servidor. A solicitação poderá ser bem-sucedida se você tentar novamente.

Mensagens de erro

Quando o código de status de nível superior não é OK, pode haver um campo error_message adicional no objeto de resposta Distance Matrix. Esse campo contém informações mais detalhadas sobre os motivos por trás do código de status fornecido.

Linhas

Quando a API Distance Matrix retorna resultados, ela os coloca em uma matriz de linhas JSON. Mesmo que nenhum resultado seja retornado (como quando as origens e/ou destinos não existem), ele ainda retorna uma matriz vazia.

As linhas são ordenadas de acordo com os valores no parâmetro de origem da solicitação. Cada linha corresponde a uma origem e cada elemento dentro dessa linha corresponde a um emparelhamento da origem com um valor de destino.

Cada matriz de linhas contém uma ou mais entradas de elementos que, por sua vez, contêm as informações sobre um único emparelhamento origem-destino.

Elementos

As informações sobre cada emparelhamento origem-destino são retornadas em uma entrada de elemento. Um elemento contém os seguintes campos:
  • status: Consulte Códigos de status para obter uma lista de possíveis códigos de status.
  • duração: o tempo necessário para percorrer essa rota, expresso em segundos (o campo de valor) e como texto.
  • distância: A distância total dessa rota, expressa em metros (valor) e como texto. O valor textual usa o sistema de unidades especificado com o parâmetro de unidade da solicitação original ou a região de origem.
PERGUNTAS FREQUENTES

Como usar a API de distância?

Usar uma API de distância como o Distancematrix.ai normalmente é um processo simples. Aqui estão as etapas básicas para usar a API:

  • Registre-se na plataforma e obtenha uma chave de API. A chave da API é um identificador exclusivo que permite acessar a API.
  • Escolha seu produto de API: A API Distancematrix.ai fornece vários métodos para diferentes tipos de cálculos de distância, como distância entre dois pontos, matriz de distância para várias origens e destinos e estimativas de tempo de viagem. Escolha a melhor maneira de usar a API que atenda às suas necessidades.
  • Defina seus parâmetros: Dependendo do produto escolhido, você precisará definir parâmetros como origens e destinos (na forma de endereços ou coordenadas de longa distância), modo de transporte (dirigir, caminhar etc.) e outras opções, como evitar pedágios ou rodovias.
  • Envie sua solicitação: depois de definir seus parâmetros, você pode enviar uma solicitação para a matriz de distância da API usando sua chave de API. A API processará sua solicitação e retornará os resultados da distância e os tempos de viagem no formato especificado em sua solicitação.
  • Armazene em cache e use os resultados: finalmente, você pode analisar os resultados retornados pela API e usá-los em seu aplicativo ou site. A API pode retornar resultados em JSON, que podem ser facilmente convertidos em vários formatos, incluindo XML e CSV.

As etapas específicas para usar a API Distancematrix.ai podem variar dependendo da sua linguagem de programação ou estrutura. No entanto, fornecemos documentação detalhada da API Distance Matrix e código de amostra para ajudar você a começar.

Qual é a diferença entre uma matriz de distância de API e outras APIs?

A matriz de distância da API, a API de distância do mapa e a API da matriz de direção são todos os tipos de APIs que fornecem dados relacionados à distância, mas têm algumas peculiaridades.
Uma matriz de distância da API foi projetada para calcular as distâncias entre várias origens e destinos. Ele fornece uma matriz de distâncias que pode ser usada para calcular o tempo de viagem ou otimizar rotas para entrega ou logística. Esse tipo de API é útil para empresas que precisam planejar e otimizar rotas de viagem ou operações logísticas.

Uma API de distância do mapa, por outro lado, fornece dados relacionados à distância para uma área geográfica específica, como a distância entre dois pontos em um mapa. Esse tipo de API é útil para aplicativos que precisam exibir dados relacionados à distância em um mapa, como um monitor de condicionamento físico ou um aplicativo de viagem.

Uma API de matriz de direção, como a API de direções do Google Maps, fornece direções passo a passo entre dois ou mais pontos. Inclui informações como a distância, o tempo estimado de viagem e a rota a ser seguida. Esse tipo de API é útil para aplicativos que exigem recursos de navegação ou roteamento, como um aplicativo de compartilhamento de caronas ou um dispositivo GPS.

Em resumo, embora a API de matriz de distância, a API de distância do mapa e a API da matriz de direção forneçam dados relacionados à distância, elas são otimizadas para diferentes casos de uso. Atualmente, a API Distance Matrix da Distancematrix.ai inclui produtos de matriz de distância e geocodificação. No momento, não fornecemos soluções de mapas ou direções. No entanto, você pode usar os dados em sua empresa para otimizar rotas de viagem ou operações logísticas. Esses dados são para aplicativos que precisam exibir dados relacionados à distância em um mapa e para aplicativos que exigem recursos de navegação ou roteamento.

Fácil integração com a API Distance Matrix
Iniciar
Como migrar para o DistanceMatrix
Não é necessário cartão de crédito. Cancele a qualquer momento!
Comece um teste gratuito de 7 dias da API Distance Matrix for Business