API de check-in online de companhias aéreas

Ajude os viajantes a chegar ao check-in online da sua companhia aérea a partir do itinerário ou de uma mensagem pré-viagem. Obtenha URLs de check-in online associados a códigos e nomes de companhias aéreas, prontos a usar na sua aplicação de viagens.

Chave de API de teste Ver exemplo
  • Ligações de check-in online
  • Consulta por código ou nome
  • JSON, XML e CSV

Obter as ligações de check-in online de uma companhia aérea

Consulte a Southwest Airlines com o código IATA WN e leia web_checkin_url. Utilize um URL devolvido para encaminhar os viajantes para a página de check-in da companhia aérea. 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=WN'

Resposta · excerto JSON

[
  {
    "iata": "WN",
    "icao": "SWA",
    "marketing_name": "Southwest Airlines",
    "web_checkin_url": "https://www.southwest.com/air/check-in/?clk=HP-CHKIN",
    ...
  }
]

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

Utilize a API de companhias aéreas para obter uma companhia aérea ou exportar o diretório. web_checkin_url é um campo da resposta. O pedido identifica a companhia aérea; não submete a reserva de um passageiro para check-in.

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 WN.
icao CondicionalNenhumConsulta uma companhia aérea pelo código ICAO de três letras, por exemplo SWA.
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

Associe web_checkin_url à identidade da companhia aérea antes de o apresentar. Este campo remete para a página de check-in da companhia; não contém o estado de check-in de um passageiro nem um cartão de embarque.

CampoTipoExemploDescrição
airhex_id Identificador1046Identificador permanente do registo na Airhex. Utilize-o para associar atualizações futuras ao mesmo registo.
iata StringWNDesignador IATA da companhia aérea, com dois caracteres. Os códigos podem conter letras e dígitos; guarde-os como texto.
icao StringSWADesignador ICAO da companhia aérea, com três letras, útil para fazer corresponder sistemas de códigos.
marketing_name StringSouthwest AirlinesNome da companhia aérea habitualmente usado, para apresentação na sua aplicação.
web_checkin_url String (URL)https://www.southwest.com/air/check-in/?clk=HP-CHKINURL do check-in online para passageiros na web.

Ver todos os dados disponíveis →

Tarefas de implementação mais comuns

Descarregar as ligações de check-in do seu diretório de companhias aéreas

Exporte o diretório em CSV e conserve web_checkin_url juntamente com os nomes, os códigos e airhex_id. Verifique se o URL está preenchido antes de apresentar um botão de check-in. Utilize onlyscheduled=0 se precisar de tipos de companhias para além das regulares e selecione os registos relevantes na 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-check-in-links.csv

Encontrar ligações de check-in pelo nome da companhia aérea

Pesquise com name, confirme a companhia pretendida e leia web_checkin_url. As pesquisas por nome admitem correspondências parciais; reveja as identidades devolvidas antes de associar uma ligação a um itinerário.

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

Obter ligações de check-in através de um código ICAO

Utilize icao quando a sua fonte fornecer um designador ICAO de companhia aérea com três letras. Este exemplo consulta a Southwest Airlines com SWA e devolve o mesmo campo web_checkin_url.

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

O que pode criar

Botões de check-in nos itinerários

Dê aos viajantes uma ligação claramente identificada para a página de check-in da sua companhia aérea a partir do ecrã de gestão de viagens.

Lembretes de check-in antes da viagem

Acrescente ligações de check-in das companhias aéreas aos lembretes, usando o momento definido pelos seus dados de reserva ou da companhia.

Orientação de check-in para as equipas de apoio

Permita que os agentes obtenham as ligações de check-in online da companhia aérea a partir do código da companhia numa reserva.

Perguntas frequentes

O que devolve a API de check-in online de companhias aéreas?

A API de companhias aéreas devolve web_checkin_url juntamente com a identidade da companhia aérea. Este campo contém uma ligação para a página de check-in online de passageiros da companhia.

Esta API faz o check-in de passageiros ou emite cartões de embarque?

Não. Fornece URLs de check-in das companhias aéreas. O passageiro conclui o check-in junto da companhia aérea, que trata da verificação da reserva, dos dados do passageiro e da emissão do cartão de embarque.

A resposta indica quando abre o check-in?

Não. O campo documentado fornece um URL, não horários de abertura específicos de cada voo nem a elegibilidade do passageiro. Utilize as instruções da companhia aérea ou os dados de reserva adequados para saber quando o check-in está disponível. Baseie os lembretes e as mensagens de disponibilidade nessa janela de check-in, e não na existência de um URL.

Posso preencher previamente o código de reserva e o nome do passageiro?

A API documentada devolve URLs de check-in e não define parâmetros de preenchimento prévio de dados do passageiro. Não parta do princípio de que pode acrescentar dados da reserva a um URL devolvido. Siga o método de integração documentado pela companhia aérea, se esta o disponibilizar.

Que ligação de check-in devo mostrar num voo em codeshare?

Siga as instruções de check-in associadas à reserva para identificar a companhia adequada e consulte depois essa companhia aérea. A API de referência não determina a responsabilidade pelo check-in de um itinerário individual.

O que devo fazer se web_checkin_url não existir?

Omita o botão de check-in ou ofereça outro caminho de apoio. A falta de dados do URL não significa que o check-in online não esteja disponível para a reserva do passageiro.

Posso guardar as ligações de check-in na minha própria base de dados?

Sim, com uma licença adequada da base de dados de companhias aéreas. Exporte o diretório em JSON, XML ou CSV e conserve as identidades das companhias com os URLs. Atualize a sua cópia periodicamente; 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 as alterações dos URLs.

Como devo apresentar uma ligação de check-in?

Utilize o web_checkin_url preenchido como destino de um botão de check-in claramente identificado. Inclua o nome da companhia aérea para que os viajantes saibam que página vão abrir.

Facilite o acesso ao check-in das companhias aéreas

Ofereça aos viajantes um caminho direto do itinerário ou do lembrete até à página de check-in online da sua companhia aérea, com ligações mantidas e associadas a códigos de companhias aéreas.

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.