Visão geral da API de Atividades Rápidas
Capacite os viajantes a reservar atividades e experiências com a API Rapid Activities.
Prévia de acesso antecipado
Esta documentação faz parte de uma iniciativa de acesso antecipado exclusiva para parceiros selecionados. Os programas beta serão lançados no terceiro trimestre de 2026, com disponibilidade geral em 2027.
Se você tiver interesse em se tornar um parceiro beta, entre em contato com seu gerente de contas.
A API Rapid Activities foi projetada para ajudar você a apresentar atividades aos viajantes por meio de um fluxo de compra e reserva fácil de integrar. Isso proporciona aos viajantes uma experiência mais completa, ao mesmo tempo que permite desbloquear novas fontes de receita.
Conceitos-chave
| Prazo | Definição |
|---|---|
| Atividade | Um evento que pode ser reservado (o que você apresenta e vende). |
| Grupo de atividades | Um conjunto de atividades semelhantes. |
| Experiência | Um invólucro conceitual/de marketing que pode conter múltiplas atividades. |
| Ingressos | Tipos de reserva para uma atividade (adulto/criança/bebê, etc.). |
| Itinerário | Uma reserva (reserva de atividade) com uma atividade e um ou mais ingressos. |
| Categorias | High-level agrupamentos que classificam experiências e atividades em temas (por exemplo, passeios pela cidade, museus ou atividades ao ar livre). |
| Atributos | Bandeiras descritivas que capturam características específicas de uma experiência ou atividade (por exemplo, acessível para cadeirantes, "ideal para famílias", "visita guiada" ou "entrada sem fila"). |
Fluxo de integração de ponta a ponta
O agendamento de atividades com esta API segue este fluxo geral.
Etapa 1: Descubra o estoque
Comece criando um catálogo estruturado de atividades por destino, pronto para ser comercializado. Este catálogo ajudará você a entender o que está disponível para venda nessa região.
Configurar um catálogo
- Mapeie regiões geográficas para o estoque subjacente (experiências, atividades e grupos de atividades) usando os endpoints region-mapping. Observação: A API de Atividades suportará apenas o parâmetro
region_IDnesta iteração.
>> Veja mais sobre regiões 2. Obtenha conteúdo detalhado das atividades (títulos, descrições, imagens, locais e categorias) em vários idiomas. 3. Obtenha avaliações e comentários de hóspedes sobre as atividades para ajudar os viajantes a comparar opções e construir confiança na experiência. 4. Preencha os resultados da pesquisa, as páginas de detalhes da atividade e os filtros (por exemplo, "ideal para famílias" ou "passeios a pé").
Filtrar por região e área
Com a API de Atividades Rápidas, você pode usar o parâmetro de consulta area para filtrar os resultados e descobrir dentro da interseção das zonas definidas pelas coordenadas region_id e area. Isso ajuda a reduzir a lógica de filtragem personalizada e a mostrar aos viajantes atividades que possam estar próximas de um ponto específico, como um hotel.
Para usar o filtro area, inclua os campos para radius_km, latitude e longitude dentro dele, representando o círculo geográfico de atividades a serem retornadas.
Exemplo de solicitação
GET /v2/regions/{region_id}/activity-groups?area=10,34.0512226,-118.2403994&pagination_size=25Nota: radius_km (o primeiro campo dentro de area) deve ser um número inteiro maior ou igual a 0.
Passo 2: Verifique a disponibilidade e os preços.
Saiba quando as atividades estão disponíveis e a que preço. Utilize datas/horários reserváveis, opções de ingressos e faixas de preço para otimizar a experiência de compra.
- Para atividades e datas específicas, solicite disponibilidade e preços por tipo de ingresso.
- Exibir calendários (datas disponíveis/indisponíveis), horários disponíveis e preços iniciais na experiência do comprador.
- Suportar múltiplas atividades em uma única chamada.
Etapa 3: Verificação de preço Pre-booking
Confirme o preço final da reserva e obtenha uma lista dos campos obrigatórios antes de efetuar o pagamento. Receba uma oferta confirmada e um código de reserva, de acordo com o estoque e as políticas mais recentes.
- Valide uma seleção específica (atividade, data, hora e ingressos) em tempo real.
- Receba o preço final, impostos/taxas e disponibilidade (incluindo alterações de preço ou esgotamento do estoque).
- Obtenha detalhes sobre os campos de reserva obrigatórios (como dados do passageiro ou tipo pick-up) e um token seguro para a reserva.
Passo 4: Criar reserva
Transforme uma seleção confirmada em uma reserva. Receba um itinerário confirmado (reserva) que você poderá visualizar e gerenciar em seus próprios sistemas.
- Envie o token de reserva do fluxo de compras como um parâmetro de consulta e o
payment_tokenda API de Pagamentos no corpo da solicitação, juntamente com os detalhes do viajante (viajante principal e adicionais). - Inclua sua própria referência de afiliado para que você possa conciliar e pesquisar reservas posteriormente.
- Receba um ID de itinerário e links para recuperar os detalhes da reserva.
Etapa 5: Gerenciar reservas
Apoiar os fluxos de trabalho pós-reserva para clientes e agentes. Acesse um conjunto completo de ferramentas pós-reserva para visualizar, cancelar e fornecer vouchers para reservas existentes.
- Recupere os detalhes da reserva pelo ID do itinerário ou pela sua referência de afiliado.
- Cancele as reservas quando permitido e informe o cliente sobre a situação resultante.
- Recupere os comprovantes de compra para que os clientes os apresentem na atividade.
Tarifas reembolsáveis
A API Rapid Activities permite filtrar atividades pelo atributo "Taxa Reembolsável" para identificar atividades que oferecem reembolso quando canceladas dentro do período de cancelamento especificado. Essa funcionalidade tem como objetivo reduzir a necessidade de lógica de filtragem personalizada e mostrar aos viajantes atividades que oferecem uma política de cancelamento mais flexível.
Filtrar atividades reembolsáveis
Use oattribute_id parâmetro com ID de atributo 25 para taxas reembolsáveis.
GET /v2/regions/{region_id}/activities?attribute_id=25
Observação: Você deve continuar a usar as informações da política disponíveis na resposta ao exibir os termos de cancelamento aos viajantes.
Exemplo de solicitação
GET /experiences/activities/content?language=en-US&activity_id=703295&activity_id=973888&activity_id=975441&activity_id=1006352&supported_booking_data_types=*&attribute_id=25Testando respostas de erro
Para enviar uma solicitação de teste para um determinado método da API de Atividades Rápidas, inclua um cabeçalho HTTP adicional chamadotest Na sua solicitação de Compras ou Reserva, utilize o valor apropriado das tabelas abaixo. A não apresentação de um cabeçalho de teste ou o envio de um cabeçalho de teste inválido fará com que a solicitação seja processada em tempo real.
Observação: O uso de um cabeçalho de teste retornará uma mensagem estática, portanto, as taxas e o conteúdo retornados podem não ser relevantes para as atividades que estão sendo testadas.
APIs de compras e conteúdo
| Valor do cabeçalho de teste | Código de HTTP e resposta | Status |
|---|---|---|
| padrão | 200 OK (resposta padrão de sucesso) | Success |
bad_link | 400 solicitação inválida (link inválido) | Erro |
invalid_input | 400 solicitação inválida (entrada inválida) | Erro |
internal_server_error | Erro 500 interno do servidor (erro desconhecido) | Erro |
service_unavailable | Serviço 503 não disponível | Erro |
API de reserva
| Valor do cabeçalho de teste | Código de HTTP e resposta | Status |
|---|---|---|
| padrão | 200 OK (resposta padrão de sucesso) | Success |
bad_link | 400 solicitação inválida (link inválido) | Erro |
invalid_input | 400 solicitação inválida (entrada inválida) | Erro |
price_mismatch | Conflito 409 (descompasso de preços) | Erro |
sold_out | Conflito 410 (esgotado) | Erro |
internal_server_error | Erro 500 interno do servidor (erro desconhecido) | Erro |
service_unavailable | Serviço 503 não disponível | Erro |
Detalhes da API
Explore as configurações do endpoint activity-related nesta página e, em seguida, use um software de teste como o Postman para entender como os exemplos e as configurações de esquema se comparam à saída real. Quando esta API passar da fase piloto, seus endpoints também serão incluídos em nosso API Explorer.