API de programas de passageiro frequente

Associe as identidades das companhias aéreas aos nomes dos respetivos programas de passageiro frequente. Obtenha os nomes dos programas juntamente com os códigos das companhias para enriquecer perfis, criar diretórios de programas de fidelização e dar contexto útil à sua aplicação de viagens.

Chave de API de teste Ver exemplo
  • Nomes de programas de passageiro frequente
  • Consulta por código ou nome
  • JSON, XML e CSV

Consultar o programa de passageiro frequente de uma companhia aérea

Consulte a United Airlines com o código IATA UA e leia ffp_name. Este exemplo devolve MileagePlus. Substitua YOUR_API_KEY pela chave atribuída.

Pedido · cURL

curl --get 'https://content.airhex.com/api/v3.7.10/airlines/' \
  --data-urlencode 'apikey=YOUR_API_KEY' \
  --data-urlencode 'iata=UA'

Resposta · excerto JSON

[
  {
    "iata": "UA",
    "icao": "UAL",
    "marketing_name": "United Airlines",
    "ffp_name": "MileagePlus",
    ...
  }
]

Resposta abreviada. As reticências (…) representam outros campos da companhia aérea omitidos aqui e não fazem parte da resposta JSON real.

Ver a referência completa: API de companhias aéreas →

Parâmetros do pedido

Consulte uma companhia aérea ou exporte o diretório e leia ffp_name nos registos devolvidos. O parâmetro name pesquisa nomes de companhias aéreas, não nomes de programas de passageiro frequente. Filtre os nomes dos programas na sua aplicação depois de obter os registos.

ParâmetroObrigatórioPredefiniçãoDescrição
apikey SimNenhumA sua chave de API atribuída. Obter chave de API de teste gratuita.
iata CondicionalNenhumConsulta uma companhia aérea pelo código IATA de dois caracteres, por exemplo UA.
icao CondicionalNenhumConsulta uma companhia aérea pelo código ICAO de três letras, por exemplo UAL.
name CondicionalNenhumProcura códigos de companhias aéreas pelo nome completo ou parcial.
dump Condicional0Defina 1 para exportar o conjunto de dados completo, sujeito ao filtro onlyscheduled.
response_type NãoJSONFormato da resposta: JSON, XML ou CSV. CSV inicia a descarga de um ficheiro.
onlyscheduled Não1Defina 1 apenas para companhias aéreas regulares ou 0 para todos os tipos de companhias aéreas.

Indique pelo menos um dos parâmetros iata, icao, name ou dump=1. Com dump=1, os restantes parâmetros de consulta são ignorados.

Ver todos os parâmetros do pedido →

Dados disponíveis

Utilize ffp_name para apresentar o programa associado ao registo da companhia aérea. Conserve a identidade da companhia aérea com o nome do programa ao criar ou atualizar um diretório local.

CampoTipoExemploDescrição
airhex_id String965Identificador permanente do registo na Airhex. Utilize-o para associar atualizações futuras ao mesmo registo.
iata StringUADesignador IATA da companhia aérea, com dois caracteres. Os códigos podem conter letras e dígitos; guarde-os como texto.
icao StringUALDesignador ICAO da companhia aérea, com três letras, útil para fazer corresponder sistemas de códigos.
marketing_name StringUnited AirlinesNome da companhia aérea habitualmente usado, para apresentação na sua aplicação.
ffp_name StringMileagePlusNome do programa de passageiro frequente da companhia aérea.

Ver todos os dados disponíveis →

Tarefas de implementação mais comuns

Descarregar os nomes dos programas de passageiro frequente das companhias aéreas

Exporte o diretório em CSV e conserve ffp_name com os nomes, os códigos e airhex_id das companhias. Utilize os nomes de programas preenchidos para criar um diretório. Defina onlyscheduled=0 se precisar de tipos de companhias para além das regulares e selecione depois os registos relevantes para a sua aplicação.

curl --get 'https://content.airhex.com/api/v3.7.10/airlines/' \
  --data-urlencode 'apikey=YOUR_API_KEY' \
  --data-urlencode 'dump=1' \
  --data-urlencode 'onlyscheduled=0' \
  --data-urlencode 'response_type=CSV' \
  --output airline-frequent-flyer-programs.csv

Encontrar um programa pelo nome da companhia aérea

Pesquise com o nome da companhia aérea, selecione o registo pretendido e leia ffp_name. A correspondência parcial por nome pode devolver várias companhias; confirme a identidade antes de apresentar um programa. Para pesquisar o próprio nome de um programa, filtre localmente o diretório descarregado.

curl --get 'https://content.airhex.com/api/v3.7.10/airlines/' \
  --data-urlencode 'apikey=YOUR_API_KEY' \
  --data-urlencode 'name=United'

Obter o nome de um programa através de um código ICAO

Utilize icao quando a sua fonte fornecer um designador de companhia aérea com três letras. Este exemplo obtém a United Airlines com UAL e lê o nome do respetivo programa de passageiro frequente no mesmo registo.

curl --get 'https://content.airhex.com/api/v3.7.10/airlines/' \
  --data-urlencode 'apikey=YOUR_API_KEY' \
  --data-urlencode 'icao=UAL'

O que pode criar

Perfis de companhias aéreas úteis

Mostre o programa de passageiro frequente indicado juntamente com o nome da companhia aérea e outras informações de referência.

Diretórios de programas de fidelização das companhias

Crie um diretório navegável que associe os nomes e os códigos das companhias aéreas aos respetivos programas de passageiro frequente.

Contexto para equipas de apoio em viagens

Dê aos agentes o nome do programa da companhia aérea ao analisarem uma reserva, mantendo as questões de conta e de benefícios associadas ao programa em causa.

Perguntas frequentes

O que devolve a API de programas de passageiro frequente?

O campo ffp_name devolve o nome do programa de passageiro frequente da companhia aérea. Está incluído no registo da API de companhias aéreas, juntamente com os nomes das companhias, os códigos e outros dados de referência.

Posso consultar um programa através do código de uma companhia aérea?

Sim. Envie um código IATA de companhia aérea em iata ou um código ICAO em icao e leia depois ffp_name. Também pode pesquisar pelo nome da companhia aérea.

Posso pesquisar diretamente o nome de um programa de passageiro frequente?

O parâmetro name documentado pesquisa nomes de companhias aéreas, não nomes de programas. Exporte o diretório com dump=1 e pesquise ou filtre ffp_name localmente se a sua aplicação precisar de pesquisa por nome de programa.

Esta API fornece saldos de milhas ou valida números de membro?

Não. ffp_name é um dado de referência da companhia aérea. Não fornece contas de passageiros, saldos, validação de adesão nem acesso a uma conta de fidelização.

Posso usar ffp_name para determinar a que programa um passageiro pode creditar um voo?

Não. O campo identifica o programa indicado no registo da companhia aérea, não todos os programas parceiros aceites numa determinada reserva. Utilize as regras da tarifa e do programa de fidelização aplicáveis para determinar o crédito de milhas e a elegibilidade. O nome, por si só, não determina as milhas acumuladas nem os benefícios do passageiro.

O nome de um programa é um identificador único?

A documentação da API não define ffp_name como identificador único de programa. Conserve a relação com a companhia aérea através de airhex_id e dos respetivos códigos, em vez de tratar o nome apresentado como chave permanente do registo.

O que devo fazer se ffp_name estiver vazio?

Omita a etiqueta do programa ou apresente “Sem programa indicado”, de acordo com o design do seu produto. Um valor vazio não determina se a companhia aérea participa noutros acordos de fidelização. Não deduza um programa a partir da aliança ou da companhia aérea-mãe.

Posso descarregar e guardar os nomes dos programas na minha própria base de dados?

Sim, com uma licença adequada da base de dados de companhias aéreas. Exporte em JSON, XML ou CSV e conserve as identidades das companhias com os nomes dos programas. Atualize periodicamente os registos guardados; a Airhex revê e atualiza diariamente os dados das companhias aéreas. Conserve airhex_id e a data e hora updated da resposta completa para captar alterações aos nomes dos programas.

Ajude os viajantes a identificar os programas de fidelização das companhias aéreas

Apresente os nomes dos programas de passageiro frequente junto da informação das companhias aéreas, dando aos viajantes e às equipas de apoio contexto útil sem manter um diretório de programas separado.

Chave de API de testePedir orçamento →

API de companhias aéreas →

Explore o conjunto de dados completo de companhias aéreas: códigos IATA e ICAO, nomes, estado operacional, tipos de companhias aéreas, alianças, programas de passageiro frequente, ligações de check-in e de política de bagagem, logótipos e cores da marca. Consulte todos os parâmetros do pedido e campos da resposta, com consultas individuais e exportações completas em JSON, XML e CSV.

API de alianças aéreas →

Consulte a aliança de uma companhia aérea por código IATA, ICAO ou nome. Crie filtros de alianças e agrupe companhias na sua aplicação com a Airhex.

API de estado de companhias aéreas →

Consulte o estado operacional das companhias aéreas (ativa, inativa ou em fase de arranque) por código ou nome e filtre o seu diretório local com a Airhex.