Paramètres de la requête
Interrogez un code de ville, trouvez des destinations par nom ou par pays, ou exportez le répertoire des villes.
| Paramètre | Obligatoire | Par défaut | Description |
|---|
apikey |
Oui | Aucun | Votre clé d'API. Obtenir une clé d'API de test gratuite. |
|---|
code |
Conditionnel | Aucun | Code IATA à trois lettres de la ville, par exemple NYC. |
|---|
country_code |
Conditionnel | Aucun | Code pays ISO à deux lettres, par exemple US, pour obtenir les villes d'un pays. |
|---|
name |
Conditionnel | Aucun | Nom de la ville ou partie du nom pour la recherche. |
|---|
dump |
Conditionnel | 0 | Avec 1, exporte toute la base de données. Prévaut sur les autres paramètres de recherche. |
|---|
response_type |
Non | JSON | Format de la réponse : JSON, XML ou CSV. CSV lance le téléchargement d'un fichier. |
|---|
Indiquez au moins l'un des paramètres code, country_code, name ou dump=1. L'API villes utilise code, et non iata, pour rechercher un code de ville.
Voir tous les paramètres de la requête →
Tâches d'intégration courantes
Télécharger les codes de ville pour votre sélecteur de destinations
Exportez le répertoire des villes en CSV et constituez un index de recherche local avec codes, noms, pays et données d'État disponibles. Affichez assez de contexte de localisation pour que les voyageurs distinguent les villes aux noms semblables.
curl --get 'https://content.airhex.com/api/v3.7.10/cities/' \
--data-urlencode 'apikey=YOUR_API_KEY' \
--data-urlencode 'dump=1' \
--data-urlencode 'response_type=CSV' \
--output city-codes.csv
Trouver le code de ville par nom de destination
Cherchez avec name et lisez code dans les enregistrements renvoyés. Les correspondances partielles peuvent donner plusieurs résultats : comparez le pays et l'État avant de choisir une destination.
curl --get 'https://content.airhex.com/api/v3.7.10/cities/' \
--data-urlencode 'apikey=YOUR_API_KEY' \
--data-urlencode 'name=New York'
Constituer une liste de destinations d'un pays
Avec country_code=US, vous obtenez les enregistrements de villes des États-Unis. Utilisez leurs codes et leurs noms pour une liste de destinations par pays ; la disponibilité des vols doit venir de votre fournisseur de réservations.
curl --get 'https://content.airhex.com/api/v3.7.10/cities/' \
--data-urlencode 'apikey=YOUR_API_KEY' \
--data-urlencode 'country_code=US'
Trouver les aéroports d'une ville
Une fois la ville résolue, passez son code comme city_code à l'API aéroports. L'exemple interroge les aéroports avec vols commerciaux de NYC. Conservez le code et le nom de chaque aéroport lorsque vous affichez des options d'aéroports ; la réponse de l'API villes n'inclut pas de liste d'aéroports.
curl --get 'https://content.airhex.com/api/v3.7.10/airports/' \
--data-urlencode 'apikey=YOUR_API_KEY' \
--data-urlencode 'city_code=NYC' \
--data-urlencode 'major_only=1'
Questions fréquentes
Quelle différence entre un code IATA de ville et un code d'aéroport ?
Un code de ville identifie une destination au niveau de la ville ; un code d'aéroport, un aéroport précis. Une ville peut être associée à plusieurs aéroports. Enregistrez le type de lieu de votre fournisseur avec le code pour que votre application sache s'il faut interroger une ville ou un aéroport.
Quel paramètre utiliser pour interroger un code de ville ?
Dans l'API villes, utilisez code, par exemple code=NYC. L'API aéroports utilise iata pour interroger un aéroport précis et city_code pour trouver les aéroports d'une ville. Ces noms de paramètres ne valent que pour leur propre endpoint.
Puis-je l'utiliser pour une option de destination « tous les aéroports » ?
Libellez la destination avec l'enregistrement de la ville et récupérez les aéroports associés avec l'API aéroports. Vérifiez comment votre fournisseur de vols accepte les recherches au niveau de la ville et quels aéroports il inclut. Les données de référence des villes ne déterminent pas à elles seules la couverture de recherche d'un fournisseur et ne garantissent pas qu'une ligne soit réservable.
Puis-je trouver un code de ville à partir du nom de la ville ?
Oui. Le paramètre name accepte les correspondances partielles. Comparez name, country_code et les champs d'État disponibles dans la réponse plutôt que de retenir automatiquement le premier résultat. Conservez le code de ville et l'enregistrement lorsque l'utilisateur a choisi une destination.
Toutes les villes ont-elles un code IATA ?
Ne considérez pas ce répertoire comme une liste de toutes les communes. Constituez votre table de correspondance de codes à partir des enregistrements de villes renvoyés et vérifiez que code est renseigné avant de créer un rapprochement fondé sur les codes. Pour les destinations que votre application ne peut pas résoudre, ne devinez pas un code d'après le nom.
Existe-t-il des noms d'États et de provinces pour tous les pays ?
Les champs documentés state_short et state_full s'appliquent aux villes des États-Unis, du Canada et d'Australie. Pour les autres destinations, attendez-vous à des valeurs vides et utilisez le nom de la ville et le code pays comme contexte d'affichage de base.
Puis-je télécharger et stocker le répertoire des codes de ville ?
Oui, avec une licence adaptée de GEO Essentials. Utilisez dump=1 et choisissez JSON, XML ou CSV avec response_type. Conservez airhex_id comme identifiant permanent de l'enregistrement et updated de la réponse complète, et mettez régulièrement à jour votre répertoire local.
L'API inclut-elle des lignes aériennes, des prix ou la disponibilité ?
Non. L'API villes fournit des données de référence sur les destinations. La couverture des lignes, les horaires, les prix et la disponibilité viennent de votre fournisseur de vols ; la présence d'une ville dans le répertoire ne signifie pas qu'un voyage donné est réservable.