Parâmetros do pedido
Consulte um código de cidade, encontre destinos por nome ou país, ou exporte o diretório de cidades.
| Parâmetro | Obrigatório | Predefinição | Descrição |
|---|
apikey |
Sim | Nenhum | A sua chave de API atribuída. Obter chave de API de teste gratuita. |
|---|
code |
Condicional | Nenhum | Código IATA de cidade com três letras, por exemplo NYC. |
|---|
country_code |
Condicional | Nenhum | Código de país ISO de duas letras, por exemplo US, para obter as cidades de um país. |
|---|
name |
Condicional | Nenhum | Nome da cidade ou parte do nome para correspondência na pesquisa. |
|---|
dump |
Condicional | 0 | Defina 1 para exportar a base de dados completa. Substitui os outros parâmetros de consulta. |
|---|
response_type |
Não | JSON | Formato da resposta: JSON, XML ou CSV. CSV inicia a descarga de um ficheiro. |
|---|
Indique pelo menos um dos parâmetros code, country_code, name ou dump=1. A API de cidades usa code, e não iata, para consultar um código de cidade.
Ver todos os parâmetros do pedido →
Tarefas de implementação mais comuns
Descarregar os códigos de cidade para o seu seletor de destinos
Exporte o diretório de cidades em CSV e crie um índice de pesquisa local a partir dos códigos, nomes, países e dados de estado disponíveis. Apresente contexto de localização suficiente para ajudar os viajantes a distinguir cidades com nomes semelhantes.
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 um código de cidade a partir do nome de um destino
Pesquise com name e leia code nos registos devolvidos. A correspondência parcial pode produzir vários resultados; compare o país e os dados de estado antes de escolher um destino.
curl --get 'https://content.airhex.com/api/v3.7.10/cities/' \
--data-urlencode 'apikey=YOUR_API_KEY' \
--data-urlencode 'name=New York'
Criar uma lista de destinos de um país
Envie country_code=US para obter os registos de cidades dos Estados Unidos. Utilize os respetivos códigos e nomes para uma lista de destinos específica de um país; a disponibilidade de voos tem de vir do seu fornecedor 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 os aeroportos associados a uma cidade
Depois de resolver uma cidade, envie o respetivo código como city_code à API de aeroportos. Este exemplo pede os aeroportos com voos comerciais associados a NYC. Conserve o código e o nome próprios de cada aeroporto ao apresentar as opções; a resposta da API de cidades não contém uma lista de aeroportos.
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'
Perguntas frequentes
Em que difere um código IATA de cidade de um código de aeroporto?
Um código de cidade identifica um destino ao nível da cidade, enquanto um código de aeroporto identifica um aeroporto individual. Uma cidade pode estar associada a vários aeroportos. Conserve o tipo de localização do fornecedor junto do respetivo código, para que a sua aplicação saiba se deve consultar uma cidade ou um aeroporto.
Que parâmetro devo usar para consultar um código de cidade?
Utilize code na API de cidades, por exemplo code=NYC. A API de aeroportos usa iata para consultar um aeroporto individual e city_code para encontrar os aeroportos associados a uma cidade. Estes nomes de parâmetros são específicos de cada endpoint.
Posso usar isto para uma opção de destino “todos os aeroportos”?
Utilize o registo da cidade para identificar o destino e a API de aeroportos para obter os aeroportos associados. Confirme como o seu fornecedor de voos aceita pesquisas ao nível da cidade e que aeroportos inclui. Os dados de referência de cidades, por si só, não definem a cobertura de pesquisa de um fornecedor nem garantem uma rota reservável.
Posso encontrar um código de cidade pesquisando o nome?
Sim. O parâmetro name admite correspondências parciais. Compare name, country_code e os campos de estado disponíveis devolvidos, em vez de selecionar automaticamente o primeiro resultado. Conserve o código e a identidade da cidade selecionada depois de o utilizador escolher um destino.
Todas as cidades têm código IATA?
Não trate este diretório como uma lista de todos os municípios. Crie a sua consulta de códigos a partir dos registos de cidades devolvidos e verifique se code está preenchido antes de criar uma correspondência por código. Trate os destinos que a sua aplicação não consiga resolver sem estimar um código a partir dos nomes.
Os nomes de estados e províncias estão disponíveis para todos os países?
Os campos state_short e state_full documentados aplicam-se a cidades dos Estados Unidos, do Canadá e da Austrália. Trate os valores vazios dos outros destinos e utilize o nome da cidade e o código do país como contexto de apresentação básico.
Posso descarregar e guardar o diretório de códigos de cidade?
Sim, com uma licença GEO Essentials adequada. Utilize dump=1 e escolha JSON, XML ou CSV com response_type. Conserve airhex_id como identificador permanente do registo e updated da resposta completa e atualize periodicamente o seu diretório local.
Inclui rotas de voos, tarifas ou disponibilidade?
Não. A API de cidades fornece dados de referência de destinos. Recorra ao seu fornecedor de voos para a cobertura de rotas, horários, tarifas e disponibilidade; o facto de uma cidade constar do diretório não significa que uma viagem em particular esteja disponível para reserva.