Documentação piloto da API de atividades rápidas
Prévia de acesso antecipado
Esta documentação faz parte de uma iniciativa de pré-visualização de acesso antecipado somente para parceiros selecionados. Os programas piloto serão lançados no terceiro trimestre de 2025, com disponibilidade geral em 2026.
Se você estiver interessado em se tornar um parceiro piloto ou beta, entre em contato com seu gerente de conta.
Evidências recentes sugerem que os viajantes estão cada vez mais buscando experiências autênticas em vez de bens materiais e, embora esse tenha sido o caso pre-Covid, é ainda mais verdadeiro em um mundo post-pandemic. A API de atividades rápidas foi projetada para ajudar os parceiros a apresentar atividades e experiências aos seus clientes por meio de um caminho de reserva end-to-end fácil de integrar. Isso permite que os clientes tenham uma experiência de reserva mais holística, além de desbloquear novas fontes de receita para parceiros.
O pacote de API Rapid /atividades
Atividades rápidas são compostas por uma seleção de pontos de extremidade que juntos permitem um fluxo search-to-book.
Como este produto ainda está na fase de acesso inicial, tenha em mente que os detalhes do esquema e a funcionalidade ainda estão em desenvolvimento ativo e podem mudar antes do lançamento completo deste produto para parceiros.
Abaixo estão os principais endpoints envolvidos:
| Ação | Método | URI de descanso | Resultado |
|---|---|---|---|
| Pesquisar atividades | GET | /atividades/disponibilidade | Recupera atividades e experiências disponíveis com base em um determinado local e intervalo de datas. |
| Veja os detalhes | GET | /atividades/{activity_id}/ofertas | Encontra ofertas para a atividade selecionada. Retorna os horários e preços de passeios etc. disponíveis para aquela atividade específica. |
| Confirmar preço | GET | /atividades/{activity_id}/ofertas/{offer_id} | Retorna um preço resumido e campos de reserva obrigatórios. |
| Cadastre um método de pagamento para a reserva | POST | /pagamentos | Registra um método de pagamento ao fazer uma reserva. A resposta incluirá um payment_tokenque será inserido no corpo da solicitação de criação de reserva. |
| Criar a reserva | POST | /itinerários/atividade | Crie a reserva. Este ponto final retornará um itinerary_idcom links de operações relevantes. |
| Solicitar detalhes de uma reserva existente por ID do itinerário | GET | /itinerários/{itinerary_id}/atividade | Retorna detalhes do itinerário pelo parâmetro itinerary_id. |
| Solicitar detalhes de uma reserva existente pelo provedor de atividades. | GET | /itinerários/atividade | Retorna os detalhes de uma reserva com base no parâmetro affiliate_reference. |
| Cancelar reserva | EXCLUIR | /itinerários/{itinerary_id}/atividade | Cancela uma reserva existente. |
Caso de uso
Veja como você pode usar a API Rapid Activities para criar uma experiência de reserva end-to-end para seus clientes.
Passo 1 - Pesquise atividades e experiências disponíveis para o local desejado
Use o ponto de extremidade /activities/availability para permitir que os viajantes vejam quais atividades estão disponíveis em seu destino durante sua estadia.
Veja os principais parâmetros abaixo:
| Parâmetro chave | Descrição | Recomendação |
|---|---|---|
start_date | Data de início da busca por atividades disponíveis. | Use o formato ISO 8601. Por exemplo, 2018-02-12. |
end_date | Data final para busca de atividades disponíveis. | Use o formato ISO 8601. Por exemplo, 2018-02-12. |
currency | Moeda solicitada para as taxas. | Use o formato ISO 4217. Por exemplo, USD. |
language | Idioma desejado para a resposta. | Use apenas códigos de idioma Alpha-2 ISO639-1 e de país Alpha-2 ISO3166-1. |
country_code | O código do país do ponto de venda do viajante. | Use o formato ISO 3166-1 alfa-2. Deve representar o país onde a transação de compra está ocorrendo. Por exemplo, EUA. |
region_id | O local ou área onde o viajante está procurando atividades. | Por exemplo, 1122931. |
limit | O número máximo de atividades retornadas na resposta. | Máximo: 100 |
Etapa 2 - Obtenha detalhes das ofertas disponíveis para a atividade desejada
Obtenha mais informações para o cliente sobre quais ofertas estão disponíveis para a atividade selecionada. O ponto de extremidade /activities/{activity_id}/offers retorna os horários e preços de coisas como passeios disponíveis para a atividade.
Aqui estão os tipos de detalhes que os viajantes precisam saber antes de reservar:
| Ponto de extremidade | Use-o para... |
|---|---|
callouts | Forneça aos clientes informações importantes sobre a atividade antes de reservar. |
inclusions | Descreva todos os recursos incluídos na atividade. |
exclusions | Forneça uma lista de recursos não incluídos na atividade. |
Etapa 3 - Confirme o preço e forneça os detalhes de pagamento
Depois que seu cliente encontrar a experiência de férias perfeita, use o ponto de extremidade /activities/{activity_id}/offers/{offer_id} para validar o preço atual e as informações de reserva necessárias.
Etapa 4 - Obtenha informações do cliente sobre o método de pagamento escolhido
Agora você pode usar o ponto de extremidade /payments para permitir que o cliente registre um método de pagamento para a reserva. A resposta conterá um payment_token, que vai no corpo da solicitação de criação de reserva.
Etapa 5 - Criar a reserva
Use o ponto de extremidade /itineraries/activity para criar uma reserva. Este ponto final retornará um itinerary_idcom todos os links de operação relevantes.
Etapa 6 - Recuperar detalhes da reserva
Você pode usar o ponto de extremidade /itineraries/{itinerary_id}/activity para recuperar detalhes da reserva usando o ID do itinerário. A resposta incluirá links de cancelamento, quando aplicável.
Detalhes da API
Explore as configurações de endpoint activity-related nesta página e, em seguida, use um software de teste para entender como os exemplos e as configurações de esquema se comparam à saída real. Quando esta API passar do estágio piloto, seus endpoints também serão incluídos em nosso API Explorer.