Documentation rapide de l'API Distance Matrix

Directives pour les développeurs
Avant de commencer
Il s'agit d'un service d'API HTTP conçu pour calculer toutes les combinaisons possibles entre le point de départ et la destination et qui vous permet d'obtenir ces données en quelques secondes et en mètres. L'API Distance Matrix Fast est disponible partout dans le monde et garantit un niveau de précision et de réponse similaire à celui des meilleurs analogues tels que l'API Google Distance Matrix. Le meilleur résultat que vous puissiez obtenir pour la langue anglaise.

Dans cette documentation Distance Matrix API Fast, vous trouverez une introduction au produit et des informations de référence sur les paramètres disponibles.

Que pouvez-vous faire avec l'API Distance Matrix Fast ?

Ce produit permet aux développeurs de calculer le temps de trajet et la distance entre certains points. Il est donc plus utile pour les entreprises qui accordent la priorité au temps de réponse par rapport à des données très précises, qui opèrent dans des secteurs dynamiques et sensibles au facteur temps où la prise de décision rapide et l'optimisation des itinéraires sont essentielles. Ainsi, il peut être utilisé pour différents types de services de livraison et de messagerie tels que la livraison de nourriture, de marchandises et de médicaments, les services de covoiturage, la logistique, etc.

Les entreprises qui envoient des techniciens ou du personnel de maintenance sur les sites des clients, telles que les entreprises de réparation de systèmes CVC ou les fournisseurs de services de câblodistribution, bénéficient de temps de réponse rapides pour planifier efficacement les rendez-vous et informer les clients des heures d'arrivée.

Les entreprises qui ont besoin de temps de réponse rapides et d'une précision extrême grâce à l'API Distance Matrix incluent également les services d'urgence, les services à la demande, la vente au détail, les voyages, la gestion de flotte et les initiatives de villes intelligentes. L'accès rapide aux données de distance est essentiel pour optimiser les itinéraires, minimiser les retards et améliorer l'expérience client dans ces secteurs où le facteur temps est essentiel.

Pourquoi utiliser l'API Distance Matrix Fast ?

Vous pouvez utiliser notre produit pour trouver le point de destination le plus proche du point d'origine ou à toute autre fin. L'API renverra une durée et une distance sur l'itinéraire le plus rapide ou le plus court de chaque élément. À son tour, chaque élément est une paire origine-destination.

Cette solution fonctionne dans le monde entier et n'est disponible que pour un mode conduite.

Si le trafic en temps réel n'affecte pas votre activité de manière significative, vous pouvez gagner du temps et améliorer les performances du produit en utilisant Distance Matrix API Fast. Pour les gros volumes de calcul, vous pouvez utiliser notre API de matrice de distance asynchrone.
Si l'exactitude des données et le trafic en temps réel sont plus importants pour votre entreprise, vous devriez consulter notre solution : API de matrice de distance précise.

Comment utiliser l'API Distance Matrix Fast ?

Vous fournissez les données d'entrée (adresses ou coordonnées) pour lesquelles vous souhaitez effectuer une estimation. Vous recevrez une réponse au format JSON, qui contiendra des informations sur la durée moyenne de chaque section d'itinéraire construite. Le temps de trajet calculé pour un tronçon de route ne tient pas compte des conditions de circulation actuelles.

Par exemple, il existe trois emplacements de départ A, B et C, et trois emplacements de destination E, B et D. L'API Distance Fast renvoie la matrice des durées en secondes/minutes et des distances en mètres/kilomètres entre les emplacements. Il ne renvoie pas les géométries des itinéraires.
origines \ destinations
E
B
D
UNE
A à E
A vers B
A à D
B
B vers E
B à B = 0
B vers D
C
C vers E
C vers B
C vers D
Le temps et la distance entre les points peuvent ne pas être symétriques, car les itinéraires peuvent différer selon la direction en raison des rues à sens unique ou des restrictions de virage. Par exemple, la durée de A à B peut être différente de celle de B à A.

Les sections suivantes vous fournissent des informations plus détaillées basées sur des exemples d'API Distance Matrix.

Paramètres de la demande

La requête Fast de l'API Distance Matrix a été créée spécifiquement pour être similaire au format de demande de l'API Google Distance Matrix. Vous pouvez obtenir plus d'informations sur Migrer vers l'API Distancematrix.ai page.
Une requête Fast de l'API Distance Matrix prend la forme suivante :
OBTENIR :
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!
Exemple de demande d'API Distance Matrix :
OBTENIR :
https://api-v2.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&key=<your_access_token>
Copied!

Paramètres requis

origines : point de départ pour calculer la distance et le temps de trajet. Vous pouvez fournir un ou plusieurs emplacements séparés par le caractère vertical (|) sous la forme d'une adresse ou de coordonnées de latitude/longitude :
1. Si vous transmettez une adresse, le service géocode la chaîne et la convertit en coordonnées de latitude/longitude pour calculer la distance. Cette coordonnée peut être différente de celle renvoyée par l'API Geocoding, par exemple, l'entrée d'un bâtiment plutôt que son centre.
Afficher l'exemple
Masquer l'exemple
Exemple de demande avec adresses :
OBTENIR :
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!
Réponse
CORPS
{
    "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 vous transmettez les coordonnées de latitude/longitude, elles sont utilisées telles quelles pour calculer la distance. Assurez-vous qu'aucun espace n'existe entre les valeurs de latitude et de longitude.
Afficher l'exemple
Masquer l'exemple
Exemple de demande avec coordonnées :
OBTENIR :
https://api-v2.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&key=<your_access_token>
Copied!
Réponse
CORPS
{
   "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!
  • destinations : une ou plusieurs destinations à utiliser comme destination finale pour le calcul de la distance et de la durée du trajet. Les options pour le paramètre de destination sont les mêmes que pour le paramètre d'origine, comme décrit ci-dessus.
  • key : la clé API de votre application.

Paramètres facultatifs

Si vous souhaitez utiliser des paramètres optionnels ; modes conduite, marche et vélo ; données de trafic en temps réel, en évitant les autoroutes, les ferries et en intérieur, veuillez choisir un autre produit, Distance Matrix API Accurate. Pour plus d'informations, n'hésitez pas à consulter sa documentation.

Exemple de réponse

La réponse contient un tableau d'objets de lignes, chaque ligne contenant une origine associée à chaque destination. Chaque élément de l'objet du tableau contient les propriétés d'une seule variante de route. Pour une description détaillée des éléments, voir la section Éléments de réponse de la matrice de distance.
Réponse
CORPS
{
   "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!

Éléments de réponse de la matrice de distance

Les réponses de la matrice de distance contiennent les éléments racines suivants :
  • status contient des métadonnées relatives à la demande. Voir Codes d'état ci-dessous.
  • origin_addresses contient un tableau d'adresses tel que renvoyé par l'API à partir de votre demande d'origine. Ils sont formatés par le géocodeur et localisés en fonction du paramètre de langue transmis avec la demande.
  • destination_addresses contient un tableau d'adresses renvoyées par l'API à partir de votre demande initiale. Comme pour les origin_addresses, celles-ci sont localisées le cas échéant.
  • les lignes contiennent un tableau d'éléments, qui contiennent à leur tour des éléments d'état, de durée et de distance.

Codes d'état

Les champs d'état de l'objet de réponse contiennent l'état de la demande et peuvent contenir des informations de débogage utiles. L'API Distance Matrix renvoie un champ d'état de niveau supérieur contenant des informations sur la demande en général, ainsi qu'un champ d'état pour chaque champ d'élément contenant des informations sur cette paire origine-destination particulière.

Codes de statut de niveau supérieur

  • OK indique que la réponse contient un résultat valide.
  • INVALID_REQUEST indique que la demande fournie n'était pas valide.
  • MAX_ELEMENTS_EXCEEDED indique que le produit d'origine et de destination dépasse la limite par requête.
  • OVER_DAILY_LIMIT indique l'un des éléments suivants :
    • La clé API est manquante ou non valide.
    • La facturation n'a pas été activée sur votre compte.
    • Le plafond d'utilisation que vous vous êtes imposé a été dépassé.
    • Le mode de paiement fourni n'est plus valide (par exemple, une carte de crédit a expiré).
  • OVER_QUERY_LIMIT indique que le service a reçu trop de demandes de votre application dans le délai imparti.
  • REQUEST_DENIED indique que le service a refusé l'utilisation du service Distance Matrix par votre application.
  • UNKNOWN_ERROR indique qu'une demande Distance Matrix n'a pas pu être traitée en raison d'une erreur du serveur. La demande peut aboutir si vous réessayez.

Codes d'état au niveau des éléments

  • OK indique la réponse et contient un résultat valide.
  • NOT_FOUND indique que l'origine et/ou la destination de ce couplage n'ont pas pu être géocodées.
  • ZERO_RESULTS indique qu'aucun itinéraire n'a pu être trouvé entre l'origine et la destination.
  • MAX_ROUTE_LENGTH_EXCEEDED indique que l'itinéraire demandé est trop long et ne peut pas être traité.

Messages d'erreur

Lorsque le code d'état de niveau supérieur est différent de OK, il peut y avoir un champ error_message supplémentaire dans l'objet de réponse Distance Matrix. Ce champ contient des informations plus détaillées sur les raisons du code de statut donné.

Lignes

Lorsque l'API Distance Matrix renvoie des résultats, elle les place dans un tableau de lignes JSON. Même si aucun résultat n'est renvoyé (par exemple lorsque les origines et/ou les destinations n'existent pas), il renvoie toujours un tableau vide.

Les lignes sont classées en fonction des valeurs du paramètre d'origine de la demande. Chaque ligne correspond à une origine, et chaque élément de cette ligne correspond à un appariement de l'origine avec une valeur de destination.

Chaque tableau de lignes contient une ou plusieurs entrées d'éléments, qui contiennent à leur tour les informations relatives à une seule paire origine-destination.

Éléments

Les informations relatives à chaque couplage origine-destination sont renvoyées dans une entrée d'élément. Un élément contient les champs suivants :
  • statut : Voir Codes d'état pour obtenir la liste des codes d'état possibles.
  • durée : durée nécessaire pour parcourir cet itinéraire, exprimée en secondes (le champ de valeur) et sous forme de texte.
  • distance : distance totale de cet itinéraire, exprimée en mètres (valeur) et sous forme de texte. La valeur textuelle utilise le système d'unités spécifié avec le paramètre d'unité de la demande d'origine, ou la région de l'origine.
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.

Intégration facile de l'API Distance Matrix
Démarrer
Comment migrer vers DistanceMatrix
Aucune carte de crédit n'est requise. Annulez à tout moment !
Commencez un essai gratuit de 7 jours de l'API Distance Matrix pour les entreprises