Documentación rápida de la API Distance Matrix

Pautas para desarrolladores
Antes de empezar
Es un servicio de API HTTP que está diseñado para calcular todas las combinaciones posibles entre el punto de partida y el destino y permite obtener estos datos en segundos y metros. La API Distance Matrix Fast está disponible en cualquier parte del mundo y garantiza un nivel similar de precisión y respuesta con los mejores análogos, como la API de matriz de distancias de Google. El mejor resultado que puede obtener en inglés.

En esta documentación de Distance Matrix API Fast, encontrará una introducción al uso del producto y material de referencia sobre los parámetros disponibles.

¿Qué puede hacer con la API Distance Matrix Fast?

Este producto garantiza a los desarrolladores un cálculo del tiempo de viaje y la distancia entre algunos puntos. Por lo tanto, es más valioso para las empresas que priorizan el tiempo de respuesta frente a los datos de alta precisión, que operan en sectores con un ritmo acelerado y en los que el tiempo apremia, donde la toma de decisiones rápidas y la optimización de las rutas son fundamentales. Por lo tanto, se puede utilizar para diferentes tipos de servicios de entrega y mensajería, como la entrega de alimentos, productos y medicamentos, los servicios de transporte compartido, la logística, etc.

Las empresas que envían técnicos o personal de servicio a las ubicaciones de los clientes, como las empresas de reparación de sistemas de calefacción, ventilación y aire acondicionado o los proveedores de servicios de cable, se benefician de tiempos de respuesta rápidos para programar citas de manera eficiente y notificar a los clientes las horas de llegada.

Las empresas que requieren tiempos de respuesta rápidos con una precisión milimétrica con la API Distance Matrix también incluyen iniciativas de servicios de emergencia, servicios bajo demanda, venta minorista, viajes, gestión de flotas y ciudades inteligentes. El acceso rápido a los datos de distancia es crucial para optimizar las rutas, minimizar las demoras y mejorar la experiencia de los clientes en estos sectores en los que el tiempo apremia.

¿Por qué deberías usar Distance Matrix API Fast?

Puede utilizar nuestro producto para encontrar el punto de destino más cercano al punto de origen o para cualquier otro propósito. La API devolverá la duración y la distancia de la ruta más rápida o corta de cada elemento. A su vez, cada elemento es un par origen-destino.

Esta solución funciona en todo el mundo y solo está disponible para el modo de conducción.

Si el tráfico en tiempo real no afecta de manera significativa a su negocio, puede ahorrar tiempo y aumentar el rendimiento del producto mediante el uso de Distance Matrix API Fast. Para grandes volúmenes de cálculo, puede considerar nuestra API de matriz de distancia asincrónica.
Si la precisión de los datos y el tráfico en tiempo real son más valiosos para su empresa, debería comprobar nuestra solución - API de matriz de distancia precisa.

¿Cómo se debe usar Distance Matrix API Fast?

Usted proporciona los datos de entrada (direcciones o coordenadas) para los que desea hacer una estimación. Recibirás una respuesta en formato JSON y la respuesta contendrá información sobre la duración promedio de cada sección de ruta construida. El tiempo de viaje calculado para una sección de ruta no tiene en cuenta las condiciones actuales del tráfico.

Por ejemplo, hay tres ubicaciones de inicio A, B y C y tres ubicaciones de destino E, B y D. La API Distance Fast devuelve la matriz de duraciones en segundos/minutos y distancias en metros/kilómetros entre las ubicaciones. No devuelve las geometrías de las rutas.
origenes/destinos
E
B
D
UN
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
Es posible que el tiempo y la distancia entre los puntos no sean simétricos, ya que las rutas pueden diferir según la dirección debido a las calles de sentido único o a las restricciones de giro. Por ejemplo, de A a B puede tener una duración diferente a la de B a A.

Las siguientes secciones proporcionan información más detallada basada en ejemplos de API de Distance Matrix.

Parámetros de solicitud

La solicitud rápida de la API Distance Matrix se creó específicamente para que fuera similar al formato de solicitud de la API de Google Distance Matrix. Puedes obtener más información en Migrar a la API Distancematrix.ai página.
Una solicitud rápida de la API Distance Matrix tiene el siguiente formato:
OBTENER:
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>
Copied!
Un ejemplo de solicitud de la API Distance Matrix:
OBTENER:
https://api-v2.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&key=<your_access_token>
Copied!

Parámetros requeridos

orígenes: un punto de partida para calcular la distancia y el tiempo de viaje. Puede indicar una o más ubicaciones separadas por el carácter vertical (|) en forma de dirección o coordenadas de latitud/longitud:
1. Si pasas una dirección, el servicio geocodifica la cadena y la convierte en una coordenada de latitud/longitud para calcular la distancia. Esta coordenada puede ser diferente de la que devuelve la API de geocodificación (por ejemplo, la entrada de un edificio en lugar de su centro).
Mostrar ejemplo
Ocultar ejemplo
Ejemplo de solicitud con direcciones:
OBTENER:
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>
Copied!
Respuesta
CUERPO
{
    "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"
}
Copied!
2. Si pasa las coordenadas de latitud/longitud, se utilizan sin cambios para calcular la distancia. Asegúrese de que no haya espacio entre los valores de latitud y longitud.
Mostrar ejemplo
Ocultar ejemplo
Ejemplo de solicitud con coordenadas:
OBTENER:
https://api-v2.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&key=<your_access_token>
Copied!
Respuesta
CUERPO
{
   "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"
}
Copied!
  • destinos: una o más ubicaciones para usar como destino final para calcular la distancia y el tiempo de viaje. Las opciones del parámetro de destino son las mismas que las del parámetro original, tal y como se ha descrito anteriormente.
  • clave: la clave de API de su aplicación.

Parámetros opcionales

Si está interesado en utilizar parámetros opcionales, modos de conducir, caminar y andar en bicicleta, datos de tráfico en tiempo real, evitar autopistas, transbordadores y espacios interiores, elija otro producto, Distance Matrix API Accurate. Para obtener más información, no dudes en consultarlo su documentación.

Ejemplo de respuesta

La respuesta contiene una matriz de objetos de filas, cada fila contiene un origen emparejado con cada destino. Cada elemento del objeto de la matriz contiene las propiedades de una sola variante de ruta. Para obtener una descripción detallada de los elementos, consulte la sección Elementos de respuesta de la matriz de distancia.
Respuesta
CUERPO
{
   "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"
}
Copied!

Elementos de respuesta de la matriz de distancia

Las respuestas de Distance Matrix contienen los siguientes elementos raíz:
  • el estado contiene los metadatos de la solicitud. Consulte Códigos de estado abajo.
  • origin_addresses contiene una matriz de direcciones devueltas por la API desde tu solicitud original. El geocodificador las formatea y las localiza de acuerdo con el parámetro de idioma que se transfirió con la solicitud.
  • destination_addresses contiene una matriz de direcciones devueltas por la API desde tu solicitud inicial. Al igual que con origin_addresses, están localizadas si es necesario.
  • las filas contienen una matriz de elementos, que a su vez contienen elementos de estado, duración y distancia.

Códigos de estado

Los campos de estado del objeto de respuesta contienen el estado de la solicitud y pueden contener información de depuración útil. La API Distance Matrix muestra un campo de estado de nivel superior con información sobre la solicitud en general, así como un campo de estado para cada campo de elemento con información sobre ese emparejamiento origen-destino en particular.

Códigos de estado de nivel superior

  • Aceptar indica que la respuesta contiene un resultado válido.
  • INVALID_REQUEST indica que la solicitud proporcionada no es válida.
  • MAX_ELEMENTS_EXCEEDED indica que el producto de origen y destino supera el límite por consulta.
  • OVER_DAILY_LIMIT indica cualquiera de las siguientes opciones:
    • __wf_reserved_heredar
      Falta la clave de API o no es válida.
    • __wf_reserved_heredar
      La facturación no se ha activado en tu cuenta.
    • __wf_reserved_heredar
      Se ha superado un límite de uso autoimpuesto.
    • __wf_reserved_heredar
      El método de pago proporcionado ya no es válido (por ejemplo, una tarjeta de crédito ha caducado).
  • OVER_QUERY_LIMIT indica que el servicio ha recibido demasiadas solicitudes de tu aplicación dentro del período de tiempo permitido.
  • REQUEST_DENIED indica que el servicio denegó el uso del servicio Distance Matrix por parte de su aplicación.
  • UNKNOWN_ERROR indica que no se pudo procesar una solicitud de Distance Matrix debido a un error del servidor. La solicitud puede realizarse correctamente si lo vuelve a intentar.

Códigos de estado a nivel de elemento

  • OK indica la respuesta y contiene un resultado válido.
  • NOT_FOUND indica que el origen o el destino de este emparejamiento no se pudieron geocodificar.
  • ZERO_RESULTS indica que no se encontró ninguna ruta entre el origen y el destino.
  • MAX_ROUTE_LENGTH_EXCEEDED indica que la ruta solicitada es demasiado larga y no se puede procesar.

Mensajes de error

Si el código de estado de nivel superior no es correcto, es posible que haya un campo error_message adicional en el objeto de respuesta Distance Matrix. Este campo contiene información más detallada sobre los motivos detrás del código de estado dado.

Filas

Cuando la API Distance Matrix devuelve resultados, los coloca dentro de una matriz de filas JSON. Incluso si no se devuelven resultados (por ejemplo, cuando los orígenes o los destinos no existen), sigue devolviendo una matriz vacía.

Las filas se ordenan según los valores del parámetro de origen de la solicitud. Cada fila corresponde a un origen y cada elemento de esa fila corresponde a una combinación del origen con un valor de destino.

Cada matriz de filas contiene una o más entradas de elementos, que a su vez contienen la información sobre un único emparejamiento origen-destino.

Elementos

La información sobre cada emparejamiento origen-destino se devuelve en una entrada de elemento. Un elemento contiene los siguientes campos:
  • estado: Consulte Códigos de estado para obtener una lista de los posibles códigos de estado.
  • duración: el tiempo que se tarda en recorrer esta ruta, expresado en segundos (el campo de valor) y como texto.
  • distancia: la distancia total de esta ruta, expresada en metros (valor) y como texto. El valor textual usa el sistema de unidades especificado con el parámetro de unidad de la solicitud original o la región de origen.
FAQ

How to use distance API?

Using a distance API like Distancematrix.ai is typically a straightforward process. Here are the basic steps for using the API:

  • Register to the platform and obtain an API key. The API key is a unique identifier that allows you to access the API.
  • Choose your API product: The Distancematrix.ai API provides several methods for different types of distance calculations, such as distance between two points, distance matrix for multiple origins and destinations, and travel time estimates. Choose the best way to use the API that suits your needs.
  • Set your parameters: Depending on the product you choose, you will need to set parameters such as the origins and destinations (in the form of addresses or lat-long coordinates), transportation mode (driving, walking, etc.), and other options such as avoiding tolls or highways.
  • Send your request: Once you have set your parameters, you can send a request to the API distance matrix using your API key. The API will process your request and return the distance results and travel times in the format specified in your request.
  • Cache and use the results: Finally, you can parse the results returned by the API and use them in your application or website. The API can return results in JSON, which can be easily converted into various formats, including XML and CSV.

The specific steps for using the Distancematrix.ai API may vary depending on your programming language or framework. However, we provide detailed Distance Matrix API documentation and sample code to help you get started.

What is the difference between an API distance matrix and other APIs?

API distance matrix, map distance API, and direction matrix API are all types of APIs that provide distance-related data, but they have some peculiarities.
An API distance matrix is designed to calculate the distances between multiple origins and destinations. It provides a matrix of distances that can be used to calculate travel time or optimize routes for delivery or logistics. This type of API is useful for businesses that need to plan and optimize travel routes or logistics operations.

A map distance API, on the other hand, provides distance-related data for a specific geographic area, such as the distance between two points on a map. This type of API is useful for applications that need to display distance-related data on a map, such as a fitness tracker or a travel app.

A direction matrix API, such as Google Maps Directions API, provides turn-by-turn directions between two or more points. It includes information such as the distance, estimated travel time, and the route to take. This type of API is useful for applications that require navigation or routing capabilities, such as a ride-sharing app or a GPS device.

In summary, while distance matrix API, map distance API, and direction matrix API all provide distance-related data, they are optimized for different use cases. The Distance Matrix API by Distancematrix.ai currently includes distance matrix and geocoding products. We don't provide maps or directions solutions right now. However, you can use the data in your business to optimize travel routes or logistics operations, this data is for applications that need to display distance-related data on a map, and for applications that require navigation or routing capabilities.

Fácil de integrar la API Distance Matrix
Comenzar
Cómo migrar a DistanceMatrix
__wf_reserved_heredar
No se requiere tarjeta de crédito. ¡Cancela en cualquier momento!
Inicie una prueba gratuita de 7 días de la API Distance Matrix para empresas