Parámetros de la solicitud
Consulte un código de ciudad, encuentre destinos por nombre o país o exporte el directorio de ciudades.
| Parámetro | Obligatorio | Predeterminado | Descripción |
|---|
apikey |
Sí | Ninguno | Su clave de API asignada. Solicitar una clave de prueba de API gratuita. |
|---|
code |
Condicional | Ninguno | Código IATA de ciudad de tres letras, por ejemplo NYC. |
|---|
country_code |
Condicional | Ninguno | Código de país ISO de dos letras, por ejemplo US, para obtener las ciudades de un país. |
|---|
name |
Condicional | Ninguno | Nombre de la ciudad o parte del nombre para la búsqueda. |
|---|
dump |
Condicional | 0 | Con 1 exporta toda la base de datos. Prevalece sobre los demás parámetros de consulta. |
|---|
response_type |
No | JSON | Formato de respuesta: JSON, XML o CSV. CSV inicia la descarga de un archivo. |
|---|
Indique al menos uno de los parámetros code, country_code, name o dump=1. La API de ciudades usa code, no iata, para consultar un código de ciudad.
Ver todos los parámetros de la solicitud →
Tareas habituales de implementación
Descargar los códigos de ciudad para su selector de destinos
Exporte el directorio de ciudades como CSV y cree un índice de búsqueda local con códigos, nombres, países y los datos de estado disponibles. Muestre suficiente contexto de ubicación para que los viajeros distingan ciudades con nombres parecidos.
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
Encontrar el código de ciudad por el nombre del destino
Busque con name y lea code de los registros devueltos. Las coincidencias parciales pueden dar varios resultados, así que compare el país y el estado antes de elegir un destino.
curl --get 'https://content.airhex.com/api/v3.7.10/cities/' \
--data-urlencode 'apikey=YOUR_API_KEY' \
--data-urlencode 'name=New York'
Crear una lista de destinos de un país
Con country_code=US obtiene los registros de ciudades de Estados Unidos. Use sus códigos y nombres para una lista de destinos por país; la disponibilidad de vuelos debe venir de su proveedor de reservas.
curl --get 'https://content.airhex.com/api/v3.7.10/cities/' \
--data-urlencode 'apikey=YOUR_API_KEY' \
--data-urlencode 'country_code=US'
Encontrar los aeropuertos de una ciudad
Una vez resuelta una ciudad, pase su código como city_code a la API de aeropuertos. El ejemplo consulta los aeropuertos con vuelos comerciales de NYC. Conserve el código y el nombre de cada aeropuerto al mostrar opciones de aeropuerto; la respuesta de la API de ciudades no incluye una lista de aeropuertos.
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'
Preguntas frecuentes
¿En qué se diferencia un código IATA de ciudad de un código de aeropuerto?
Un código de ciudad identifica un destino a nivel de ciudad; un código de aeropuerto, un aeropuerto concreto. Una ciudad puede estar asociada a varios aeropuertos. Registre el tipo de lugar de su proveedor junto con el código para que su aplicación sepa si debe consultar una ciudad o un aeropuerto.
¿Qué parámetro uso para consultar un código de ciudad?
En la API de ciudades use code, por ejemplo code=NYC. La API de aeropuertos usa iata para consultar un aeropuerto concreto y city_code para encontrar los aeropuertos de una ciudad. Estos nombres de parámetro solo valen para su propio endpoint.
¿Puedo usarlo para una opción de destino “todos los aeropuertos”?
Rotule el destino con el registro de la ciudad y obtenga los aeropuertos asociados con la API de aeropuertos. Aclare cómo acepta su proveedor de vuelos las búsquedas a nivel de ciudad y qué aeropuertos incluye. Los datos de referencia de ciudades por sí solos no determinan la cobertura de búsqueda de un proveedor ni garantizan una ruta reservable.
¿Puedo encontrar un código de ciudad por el nombre de la ciudad?
Sí. El parámetro name admite coincidencias parciales. Compare name, country_code y los campos de estado disponibles en la respuesta en lugar de tomar automáticamente el primer resultado. Conserve el código de ciudad y el registro cuando el usuario haya elegido un destino.
¿Todas las ciudades tienen un código IATA?
No considere este directorio una lista de todos los municipios. Cree su tabla de consulta de códigos a partir de los registros de ciudades devueltos y compruebe que code tenga valor antes de crear una asociación basada en códigos. En los destinos que su aplicación no pueda resolver, no adivine un código a partir del nombre.
¿Hay nombres de estados y provincias para todos los países?
Los campos documentados state_short y state_full se aplican a las ciudades de Estados Unidos, Canadá y Australia. En otros destinos cuente con valores vacíos y use el nombre de la ciudad y el código de país como contexto básico para mostrar.
¿Puedo descargar y guardar el directorio de códigos de ciudad?
Sí, con una licencia adecuada de GEO Essentials. Use dump=1 y elija JSON, XML o CSV con response_type. Conserve airhex_id como identificador permanente del registro y updated de la respuesta completa, y actualice su directorio local con regularidad.
¿La API incluye rutas de vuelo, tarifas o disponibilidad?
No. La API de ciudades ofrece datos de referencia de destinos. La cobertura de rutas, los horarios, las tarifas y la disponibilidad los obtiene de su proveedor de vuelos; que una ciudad figure en el directorio no demuestra que un viaje concreto se pueda reservar.