Entrega de API para itinerários
Com o recurso Itinerários, você pode exibir as informações de reserva dos clientes e ajudá-los a encontrar produtos ou serviços da booking-related, como passeios ou experiências. Você também pode usar os dados para analisar tendências de reservas e criar relatórios para seus stakeholders.
Opções de entrega
A entrega de dados de itinerários pela sua API pode usar um mecanismo de envio (push) ou de solicitação (pull).
Mecanismo push
O serviço de notificações push foi projetado para enviar atualizações de itinerário assim que estiverem disponíveis no horário near-real, com foco nos detalhes principais do transaction-level. Esta opção permite que você:
- Exiba as informações de reserva dos clientes em seu site ou aplicativo.
- Ofereça aos viajantes produtos e serviços adicionais para compra durante a viagem.
Os eventos push serão entregues via Webhook para o URL que você fornecer, no formato de uma mensagemHTTP POST. Essas mensagens podem chegar sem ordem, portanto, consulte os elementos creation_datee update_date_timepara determinar a ordem.
Para obter detalhes sobre como adotar essa opção de entrega, consulte Configuração da API.
Mecanismo pull
O serviço de consulta fornece dados detalhados de itinerário para auxiliar em:
- Análise de dados
- Recuperação de dados para janelas de tempo em que a entrega push falhou.
- Investigações do help desk
Este serviço consiste em dois endpoints HTTP GETque permitem:
- Crie uma lista de itinerários criados ou atualizados em um intervalo de tempo específico usando as variáveis
creation_date_start,creation_date_end,update_date_time_starteupdate_date_time_end. - Recupere itinerários específicos por meio deles.
itinerary_id
Para obter detalhes sobre o processo de autenticação, consulte Configuração da API.
Campos disponíveis
As tabelas abaixo listam os campos, incluindo quaisquer objetos aninhados, disponíveis por meio dos nossos métodos de entrega push e pull.
Nomes de campo que começam com um nome seguido por um ponto (por exemplo, <variável>.<variável aninhada>) indicam uma relação de aninhamento.
Plataforma de viagens de marca branca
| Nome do campo | Definição | Exemplo |
|---|---|---|
itinerary_id | O número do itinerário ou número de referência do pedido do ponto de venda. | 72622069245694 |
status | O status do itinerário e dos seus itens individuais. | Valores possíveis: confirmado cancelado |
creation_date* | A data em que uma reserva foi feita inicialmente, representada no formato de data ISO 8601 (YYYY-MM-DD). | 2023-02-05 |
update_date_time* | A data e hora da última atualização do itinerário, representadas no formato de data ISO 8601 (YYYY-MM-dd'T"HH:mm:ss.SSSZ). | 2023-10-21T00:00:00.000Z |
online | Indica se o itinerário foi reservado online (verdadeiro) ou por meio de um agente (falso). Representado como um booleano. | true |
package | Indica se o itinerário faz parte de um pacote ou se é uma reserva independente. Representado como um booleano. | false |
payment_type | A forma de pagamento usada na compra. | Valores possíveis: credit card points split pay |
point_of_sale_country_code | O código do país do ponto de venda em que o cliente fez a reserva. Representado com duas letras, no formato ISO 3166-1 alpha-2. | GB |
purchaser | Identificação da pessoa que fez a reserva. Consulte a tabela purchaser para ver uma lista dos itens aninhados. | |
property_booking_items | Componentes de acomodação reservados como parte do itinerário. Consulte a tabela property_booking_items para ver uma lista dos itens aninhados. | |
flight_booking_items | Componentes aéreos reservados como parte do itinerário. Consulte a tabela flight_booking_items para ver uma lista dos itens aninhados. | |
car_booking_items | Carros reservados como parte do itinerário. Consulte a tabela car_booking_items para ver uma lista dos itens aninhados. | |
activity_booking_items | Atividades reservadas como parte do itinerário. Consulte a tabela activity_booking_items para ver uma lista dos itens aninhados. | |
insurance_booking_items | Seguro reservado como parte do itinerário. Consulte a tabela insurance_booking_items para ver uma lista dos itens aninhados. | |
rate | Os detalhes do preço e da tarifa de um item da reserva ou de todo o itinerário. Consulte a tabela rate para ver uma lista dos itens aninhados. | |
coupon | O cupom aplicado ao itinerário, quando aplicável. Consulte a tabela coupon para ver uma lista dos itens aninhados. |
Observações para todos os campos da Plataforma de Viagens White Label
* Os campos de data estão em Tempo Universal Coordenado (UTC).
** Isto representa dados de Informação de Identificação Pessoal (PII). Lide com isso da maneira correta, conforme as diretrizes da sua empresa. Inclua apenas quando for necessário.
*** Os dados para esses campos estarão disponíveis entre 18h e 20h UTC do dia seguinte à criação ou atualização da reserva. Não está disponível quase em tempo real.
Programa de Afiliados para Agentes de Viagens (TAAP)
| Nome do campo | Definição | Exemplo |
|---|---|---|
itinerary_id | O número do itinerário ou número de referência do pedido do ponto de venda. | 72622069245694 |
status | O status do itinerário e dos seus itens individuais. | Valores possíveis: confirmado cancelado |
creation_date* | A data em que uma reserva foi feita inicialmente, representada no formato de data ISO 8601 (YYYY-MM-DD). | 2023-02-05 |
update_date_time* | A data e hora da última atualização do itinerário, representadas no formato de data ISO 8601 (YYYY-MM-dd'T"HH:mm:ss.SSSZ). | 2023-10-21T00:00:00.000Z |
online | Indica se o itinerário foi reservado online (verdadeiro) ou por meio de um agente (falso). Representado como um booleano. | true |
point_of_sale_country_code | O código do país em que o cliente fez a reserva. Representado com duas letras, no formato ISO 3166-1 alpha-2. | GB |
purchaser | Identificação da pessoa que fez a reserva. Consulte a tabela purchaser para ver uma lista dos itens aninhados. | |
agency | Identificação da agência TAAP e do agente que fez a reserva. Consulte a tabela agency para ver uma lista dos itens aninhados. | |
payment | Informações de pagamento para o itinerário. Consulte a tabela payment para ver uma lista dos itens aninhados. | |
property_booking_items | Componentes de acomodação reservados como parte do itinerário. Consulte a tabela property_booking_items para ver uma lista dos itens aninhados. | |
flight_booking_items | Componentes aéreos reservados como parte do itinerário. Consulte a tabela flight_booking_items para ver uma lista dos itens aninhados. | |
car_booking_items | Carros reservados como parte do itinerário. Consulte a tabela car_booking_items para ver uma lista dos itens aninhados. | |
activity_booking_items | Atividades reservadas como parte do itinerário. Consulte a tabela activity_booking_items para ver uma lista dos itens aninhados. | |
rate | Os detalhes do preço e da tarifa de um item da reserva ou de todo o itinerário. Consulte a tabela rate para ver uma lista dos itens aninhados. | |
earnings | Detalhes da comissão referente a um item da reserva ou ao itinerário completo. Consulte a tabela earnings para ver uma lista dos itens aninhados. |
Notas para todos os campos TAAP
* Os campos de data estão em Tempo Universal Coordenado (UTC).
** Isto representa dados de Informação de Identificação Pessoal (PII). Lide com isso da maneira correta, conforme as diretrizes da sua empresa. Inclua apenas quando for necessário.
*** Os dados para esses campos estarão disponíveis entre 18h e 20h UTC do dia seguinte à criação ou atualização da reserva. Não está disponível quase em tempo real.
Detalhes da API
Fornecemos um resumo do esquema e das configurações da API com base em como sua empresa usaria os dados da API de Itinerários. Você pode baixar as especificações OpenAPI e usar um software de teste de API para entender como os exemplos e as configurações de esquema se comparam à saída real.
Plataforma de viagens de marca branca
Os campos, incluindo quaisquer objetos aninhados, disponíveis para nossos parceiros da Plataforma de Viagens White Label por meio de nossos métodos de entrega push e pull são:
TAAP
Os campos, incluindo quaisquer objetos aninhados, disponíveis para nossos parceiros TAAP por meio de nossos métodos de entrega push e pull são: