API Distance Matrix | Temps de trajet et distance

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 de prendre en compte la congestion du trafic et un mode de transport spécifique. Cette API de temps de trajet 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.

Dans cette documentation de l'API Distance Matrix, vous trouverez une introduction à l'utilisation du produit et des informations de référence sur les paramètres disponibles.

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

Ce produit permet aux développeurs de calculer le temps de trajet et la distance entre certains points. Ainsi, différents types de services de livraison et de messagerie tels que la livraison de nourriture, de marchandises et de médicaments présentent des avantages significatifs de leur utilisation. En outre, vous pouvez utiliser notre API pour la planification d'itinéraires, la logistique et le transport, ainsi que pour le développement de logiciels, l'immobilier et les services aux particuliers et aux entreprises.

En particulier, le produit est extrêmement utile pour les applications de taxi. Il permet de calculer le délai de livraison des voitures tout en respectant les embouteillages et les embouteillages.

Pour choisir l'itinéraire le plus court du service de livraison de nourriture dans les cafés et les restaurants, notre API de temps de trajet calcule le délai de livraison de chaque restaurant à l'adresse du client en tenant compte de la congestion routière.

Pourquoi utiliser l'API Distance Matrix ?

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 est disponible pour les modes de transport en voiture, à pied, à vélo et en transport en commun.

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 sa version sans surveillance du trafic. Pour un volume de calcul important, vous pouvez envisager notre API de matrice de distance asynchrone.

Comment utiliser l'API Distance Matrix

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 de chaque section d'itinéraire construite. Le temps de trajet calculé pour un tronçon de route tient toujours compte des conditions de circulation actuelles et des prévisions de trafic.

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 renvoie la matrice des durées en secondes et des distances en mè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 demande d'API Distance Matrix a été créée spécifiquement pour être similaire au format de demande d'API Google Distance Matrix. Vous pouvez obtenir plus d'informations sur Migrer vers l'API Distancematrix.ai page.
Une demande d'API Distance Matrix prend la forme suivante :
OBTENIR :
https://api.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.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.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.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

  • mode (par défaut, conduite) : spécifie le mode de transport à utiliser pour calculer la distance. Les valeurs valides et les autres détails de la demande sont spécifiés dans Modes de voyage section de ce document.
  • langue : langue utilisée pour renvoyer les résultats.
    • Consultez la liste des langues prises en charge.
    • Si la langue n'est pas fournie, l'API tente d'utiliser la langue préférée spécifiée dans l'en-tête Accept-Language, ou la langue maternelle du domaine à partir duquel la demande est envoyée.
    • L'API fait de son mieux pour fournir une adresse postale lisible à la fois pour l'utilisateur et pour les habitants. Pour atteindre cet objectif, il renvoie les adresses postales dans la langue locale, translittérées dans un script lisible par l'utilisateur si nécessaire, en respectant la langue préférée. Toutes les autres adresses sont renvoyées dans la langue préférée. Les composants d'adresse sont tous renvoyés dans la même langue, qui est choisie parmi le premier composant.
    • Si aucun nom n'est disponible dans la langue préférée, l'API utilise la correspondance la plus proche.
    • La langue préférée a une faible influence sur l'ensemble de résultats que l'API choisit de renvoyer et sur l'ordre dans lequel ils sont renvoyés. Le géocodeur interprète les abréviations différemment selon la langue, comme les abréviations pour les types de rues ou les synonymes qui peuvent être valides dans une langue mais pas dans une autre. Par exemple, utca et tér sont synonymes de rue en hongrois.
Afficher les langues
Masquer les langues
Code de langue
Langue
Code de langue
Langue
af
Afrikaans
ja
japonais

albanais
kn
Kannada
am
Amharique
kk
Kazakh
am
arabe
km
Khmer
pourquoi
arménien
ko
Coréen
az
azerbaïdjanais
ky
kirghize
ue
Basque
lo
laotien
être
biélorusse
lv
letton
milliards
Bengali
lt
lituanien
bs
bosniaque
mk
Macédonien
bg
Bulgare
ms
Malais
mon
Birman
ml
Malayalam
californie
Catalan
m.
Marathi
zh
chinois
mn
mongol
zh-CN
Chinois (simplifié)
ne
népalais
zh-HK
Chinois (Hong Kong)
non
Norvégien
zh-TW
Chinois (traditionnel)
pl
polonais
heure
Croate
pt
portugais
cs
tchèque
PT-BR
Portugais (Brésil)
da
danois
Pt-PT
Portugais (Portugal)
nl
néerlandais
pa
Pendjabi
fr
Anglais
ro
roumain
fr-AU
Anglais (australien)
ru
russe
fr-GB
Anglais (Grande-Bretagne)
sr
serbe
et
estonien
si
Cinghalais
fa
Farsi
sk
slovaque
fi
finnois
sl
slovène
fichier
Philippin
El Salvador
espagnol
fr
français
es-419
Espagnol (Amérique latine)
FR-CA
Français (Canada)
so
Swahili
grand livre
Galicien
sv
Suédois
ka
géorgien
assistant pédagogique
Tamoul
de
allemand
te
télougou
el
Grec
th
Thaï
gu
Gujarati
tr
Turc
iwi
Hébreu
royaume-uni
Ukrainien
salut.
Hindi
ur
ourdou
hu
Hongrois
uz
Ouzbek
est
islandais
vi
Vietnamien
identifiant
indonésien
zu
Zoulou
il
italien


  • éviter — introduit des restrictions sur l'itinéraire. Les valeurs valides sont spécifiées dans Restrictions section de ce document. Une seule restriction peut être spécifiée.
  • unités : spécifie le système d'unités à utiliser pour exprimer la distance sous forme de texte. Consultez les Systèmes unitaires section de ce document pour plus d'informations.
  • arrival_time — spécifie l'heure d'arrivée souhaitée pour les demandes de transit, en secondes depuis minuit, le 1er janvier 1970, UTC. Vous pouvez spécifier l'heure de départ ou l'heure d'arrivée, mais pas les deux. Notez que arrival_time doit être spécifié sous forme d'entier.
Afficher l'exemple
Masquer l'exemple
Exemple de requête avec arrival_time :
OBTENIR :
https://api.distancematrix.ai/maps/api/distancematrix/json?origins=51.507033,-0.1277161&destinations=52.486243,-1.890401&arrival_time=now&transit_mode=bus&mode=transit&key=<your_access_token>
Copied!
Réponse
CORPS
{
    "destination_addresses": [
        "Raw Network, Sherborne B16 8FN, United Kingdom"
    ],
    "origin_addresses": [
        "Giaralis Karavasilis Tsavdaridis, 49 The Mall, London N14 6LR, United Kingdom"
    ],
    "rows": [
        {
            "elements": [
                {
                    "distance": {
                        "text": "166.4 km",
                        "value": 166409
                    },
                    "duration": {
                        "text": "4 hour 2 mins",
                        "value": 14524
                    },
                    "origin": "51.507033,-0.1277161",
                    "destination": "52.486243,-1.890401",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copied!
  • departure_time — heure de départ souhaitée. Vous pouvez spécifier l'heure sous la forme d'un entier en secondes depuis minuit, le 1er janvier 1970, UTC. Vous pouvez également spécifier la valeur now, qui définit l'heure de départ à l'heure actuelle (à la seconde près). L'heure de départ doit être réglée sur l'heure actuelle ou dans le futur. Cela ne peut pas appartenir au passé. Les résultats d'une demande donnée peuvent varier dans le temps en raison de l'évolution du réseau routier, de la mise à jour des conditions de circulation moyennes et de la nature distribuée du service. Les résultats peuvent également varier entre des itinéraires presque équivalents à tout moment et à toute fréquence. L'heure de départ peut être spécifiée dans deux cas :
    • Pour les demandes où le mode de voyage est le transit : vous pouvez éventuellement spécifier l'une des options departure_time ou arrival_time. Si aucune heure n'est spécifiée, le departure_time est défini par défaut sur now (c'est-à-dire que l'heure de départ est par défaut l'heure actuelle).
    • Pour les demandes concernant le mode de déplacement : vous pouvez spécifier l'heure de départ pour recevoir un itinéraire et la durée du trajet (champ de réponse : duration_in_traffic) qui tiennent compte des conditions de circulation. L'heure de départ doit être réglée sur l'heure actuelle ou dans le futur. Cela ne peut pas appartenir au passé.
* Remarque : si l'heure de départ n'est pas spécifiée, le choix de l'itinéraire et de la durée est basé sur le réseau routier et les conditions de circulation moyennes indépendantes de l'heure. Les résultats d'une demande donnée peuvent varier dans le temps en raison de l'évolution du réseau routier, de la mise à jour des conditions de circulation moyennes et de la nature distribuée du service. Les résultats peuvent également varier entre des itinéraires presque équivalents à tout moment et à toute fréquence.
Afficher l'exemple
Masquer l'exemple
Exemple de requête avec departure_time :
OBTENIR :
https://api.distancematrix.ai/maps/api/distancematrix/json?origins=51.507033,-0.1277161&destinations=52.486243,-1.890401&departure_time=now&key=<your_access_token>
Copied!
Réponse
CORPS
{
    "destination_addresses": [
        "Raw Network, Sherborne B16 8FN, United Kingdom"
    ],
    "origin_addresses": [
        "Giaralis Karavasilis Tsavdaridis, 49 The Mall, London N14 6LR, United Kingdom"
    ],
    "rows": [
        {
            "elements": [
                {
                    "distance": {
                        "text": "207.3 km",
                        "value": 207323
                    },
                    "duration": {
                        "text": "2 hour 27 mins",
                        "value": 8844
                    },
                    "duration_in_traffic": {
                        "text": "2 hour 29 mins",
                        "value": 8968
                    },
                    "origin": "51.507033,-0.1277161",
                    "destination": "52.486243,-1.890401",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copied!
  • traffic_model (best_guess par défaut) : spécifie les hypothèses à utiliser pour calculer le temps passé dans le trafic. Ce paramètre affecte la valeur renvoyée dans le champ duration_in_traffic de la réponse, qui contient la durée prévue du trafic sur la base de moyennes historiques. Le paramètre traffic_model ne peut être spécifié que pour les demandes où le mode de déplacement est actif et où la demande inclut un departure_time. Les valeurs disponibles pour ce paramètre sont les suivantes :
    • best_guess (par défaut) indique que le duration_in_traffic renvoyé doit être la meilleure estimation du temps de trajet compte tenu de ce que l'on sait des conditions de trafic historiques et du trafic réel. Le trafic en temps réel prend de l'importance à mesure que l'heure de départ se rapproche de maintenant.
    • pessimistic indique que le duration_in_traffic renvoyé devrait être plus long que le temps de trajet réel la plupart des jours, bien que des jours occasionnels avec des conditions de circulation particulièrement mauvaises puissent dépasser cette valeur. Affecte le champ de la réponse distance_in_traffic_model, renvoyant l'itinéraire le plus court.
    • optimistic indique que le duration_in_traffic renvoyé devrait être plus court que le temps de trajet réel la plupart des jours, bien que des jours occasionnels où les conditions de circulation soient particulièrement bonnes puissent être plus rapides que cette valeur. Affecte le champ de la réponse distance_in_traffic_model, renvoyant l'itinéraire le plus court.
Afficher l'exemple
Masquer l'exemple
Exemple de requête avec traffic_model :
OBTENIR :
https://api.distancematrix.ai/maps/api/distancematrix/json?origins=51.507033,-0.1277161&destinations=52.486243,-1.890401&traffic_model=pessimistic&departure_time=now&key=<your_access_token>
Copied!
Réponse
CORPS
{
    "destination_addresses": [
        "Raw Network, Sherborne B16 8FN, United Kingdom"
    ],
    "origin_addresses": [
        "Giaralis Karavasilis Tsavdaridis, 49 The Mall, London N14 6LR, United Kingdom"
    ],
    "rows": [
        {
            "elements": [
                {
                    "distance": {
                        "text": "207.3 km",
                        "value": 207323
                    },
                    "duration": {
                        "text": "2 hour 27 mins",
                        "value": 8844
                    },
                    "duration_in_traffic": {
                        "text": "4 hour 0 mins",
                        "value": 14400
                    },
                    "distance_in_traffic_model": {
                        "text": "118 miles",
                        "value": 189274
                    },
                    "origin": "51.507033,-0.1277161",
                    "destination": "52.486243,-1.890401",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copied!
  • transit_mode — spécifie un ou plusieurs modes de transit préférés. Ce paramètre ne peut être spécifié que pour les demandes dont le mode est transit. Le paramètre prend en charge les arguments suivants :
    • bus indique que l'itinéraire calculé doit être préféré en bus.
    • metro indique que l'itinéraire calculé doit préférer le transport en métro.
    • train indique que l'itinéraire calculé doit préférer le voyage en train.
    • tram indique que l'itinéraire calculé doit privilégier les déplacements en tramway et en tramway.
    • rail indique que l'itinéraire calculé doit être préféré en train, en tramway, en tramway et en métro. Cela équivaut à transit_mode=train|tram|subway.
Afficher l'exemple
Masquer l'exemple
Exemple de requête avec transit_mode :
OBTENIR :
https://api.distancematrix.ai/maps/api/distancematrix/json?origins=51.507033,-0.1277161&destinations=52.486243,-1.890401&transit_mode=bus|train|tram|subway&mode=transit&departure_time=now&key=<your_access_token>
Copied!
Réponse
CORPS
{
    "destination_addresses": [
        "Raw Network, Sherborne B16 8FN, United Kingdom"
    ],
    "origin_addresses": [
        "Giaralis Karavasilis Tsavdaridis, 49 The Mall, London N14 6LR, United Kingdom"
    ],
    "rows": [
        {
            "elements": [
                {
                    "distance": {
                        "text": "207.3 km",
                        "value": 207323
                    },
                    "duration": {
                        "text": "2 hour 27 mins",
                        "value": 8844
                    },
                    "duration_in_traffic": {
                        "text": "2 hour 29 mins",
                        "value": 8968
                    },
                    "origin": "51.507033,-0.1277161",
                    "destination": "52.486243,-1.890401",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copied!

Modes de voyage

Pour le calcul des distances, vous pouvez spécifier le mode de transport à utiliser. Par défaut, les distances sont calculées pour le mode de conduite. Les modes de déplacement suivants sont pris en charge :
  • driving (par défaut) indique le calcul de la distance à l'aide du réseau routier.
  • la marche demande le calcul de la distance à parcourir pour marcher sur les sentiers piétonniers et les trottoirs (le cas échéant).
  • le vélo demande le calcul de la distance à parcourir à vélo via les pistes cyclables et les rues préférées (le cas échéant).
  • transit demande le calcul de la distance via les itinéraires de transport en commun (le cas échéant). Si vous configurez le mode de transit, vous devez spécifier une heure de départ ou une heure d'arrivée. Si aucune heure n'est spécifiée, le departure_time est défini par défaut sur now (c'est-à-dire que l'heure de départ est par défaut l'heure actuelle). Vous devez également inclure un transit_mode.
Afficher l'exemple
Masquer l'exemple
Exemple de demande avec des modes de déplacement :
OBTENIR :
https://api.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&mode=walking&departure_time=now&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": "5.7 km",
                        "value": 5699
                    },
                    "duration": {
                        "text": "1 hour 12 mins",
                        "value": 4379
                    },
                    "origin": "51.4822656,-0.1933769",
                    "destination": "51.4994794,-0.1269979",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copied!

Informations sur le trafic

Les informations sur le trafic sont utilisées lorsque tous les conditions suivantes s'appliquent (ce sont les conditions requises pour recevoir le champ duration_in_traffic dans la réponse Distance Matrix) :
  • Le paramètre du mode de déplacement est la conduite, ou il n'est pas spécifié (la conduite est le mode de déplacement par défaut).
  • La demande inclut un paramètre departure_time valide. L'heure de départ peut être réglée à l'heure actuelle ou à une autre heure.
Vous pouvez éventuellement inclure le paramètre traffic_model dans votre demande pour spécifier les hypothèses à utiliser lors du calcul de la durée du trafic.
Afficher l'exemple
Masquer l'exemple
Exemple de demande contenant des informations sur le trafic :
OBTENIR :
https://api.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&mode=driving&departure_time=now&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
                    },
                    "duration_in_traffic": {
                        "text": "23 mins",
                        "value": 1395
                    },
                    "origin": "51.4822656,-0.1933769",
                    "destination": "51.4994794,-0.1269979",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copied!

Restrictions

Les distances peuvent être calculées en fonction de certaines restrictions. Les restrictions sont indiquées par l'utilisation du paramètre avoid et d'un argument associé à ce paramètre indiquant la restriction à éviter. Les restrictions suivantes sont prises en charge :
  • éviter = péages
  • éviter = autoroutes
  • éviter = ferries
  • éviter = intérieur
* Remarque : l'ajout de restrictions n'empêche pas les itinéraires qui incluent la fonctionnalité restreinte ; cela biaise simplement le résultat en faveur des itinéraires les plus favorables.
Afficher l'exemple
Masquer l'exemple
Exemple de demande avec restrictions :
OBTENIR :
https://api.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&mode=driving&departure_time=now&avoid=ferries&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
                    },
                    "duration_in_traffic": {
                        "text": "26 mins",
                        "value": 1568
                    },
                    "origin": "51.4822656,-0.1933769",
                    "destination": "51.4994794,-0.1269979",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copied!

Systèmes unitaires

Les résultats de la matrice de distance contiennent du texte dans les champs de distance pour indiquer la distance de l'itinéraire calculé. Le système d'unités à utiliser peut être spécifié :
  • units=metric (par défaut) renvoie les distances en kilomètres et en mètres.
  • units=imperial renvoie les distances en miles et en pieds.
Afficher l'exemple
Masquer l'exemple
Exemple de demande avec système d'unités :
OBTENIR :
https://api.distancematrix.ai/maps/api/distancematrix/json?origins=51.4822656,-0.1933769&destinations=51.4994794,-0.1269979&departure_time=now&units=imperial&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": "4.7 mi",
                        "value": 7567
                    },
                    "duration": {
                        "text": "22 mins",
                        "value": 1359
                    },
                    "duration_in_traffic": {
                        "text": "26 mins",
                        "value": 1568
                    },
                    "origin": "51.4822656,-0.1933769",
                    "destination": "51.4994794,-0.1269979",
                    "status": "OK"
                }
            ]
        }
    ],
    "status": "OK"
}
Copied!
* Remarque : ce réglage du système d'unités n'affecte que le texte affiché dans les champs de distance. Les champs de distance contiennent également des valeurs qui sont toujours exprimées en mètres.

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é.
  • 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.

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.
  • duration_in_traffic : durée nécessaire pour parcourir cet itinéraire, en fonction des conditions de circulation actuelles et historiques.
  • 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.
  • distance_in_traffic_model : distance la plus courte nécessaire pour parcourir cet itinéraire, en fonction des conditions de circulation actuelles et historiques.
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
Aucun prépaiement n'est nécessaire.
Démarrez gratuitement et passez à l'action
accès à tous les fichiers Distancematrix.ai
produits et fonctionnalités