Introdução à API de análise

É fácil começar a usar a API de análise. Consiga uma chave de API e um segredo compartilhado e comece a testar.

1. Torne-se parceiro

Para fazer a integração à API de análise, você primeiro precisa se tornar parceiro de modelo sem marca. Se ainda não for, você pode se inscrever no site da Expedia Partner Solutions.

Torne-se um parceiro de modelo sem marca

2. Selecione as suas opções

Depois de se tornar parceiro, você pode escolher entre as nossas opções de domínio de dados:

• Pontos de fidelidade: conceda pontos para clientes que compram viagens com você
• Itinerários: ofereça suporte para clientes que precisam ajustar ou cancelar os planos de viagem que fizeram pelo seu site

Depois, você recebe as suas credenciais da API e configura a autenticação. O método de autenticação varia com base no mecanismo de entrega que você estiver integrando.

3. Prepare-se para a autenticação pelo método push

As notificações são enviadas pelo método push para o ponto de extremidade fornecido. Para garantir uma transmissão de dados segura e confiável, cada evento inclui uma assinatura de cabeçalho gerada com a sua chave de API e o seu segredo compartilhado. A assinatura de cabeçalho permite que você autentique e verifique a Expedia como remetente.

4. Configure a autenticação do método pull

Para ter acesso aos pontos de extremidade dos pontos de fidelidade e itinerários, você precisa de uma chave de API e um segredo compartilhado.

4.1 Solicite um token de acesso

Você vai receber um token válido que incorpora as suas credenciais (fale com o seu Gerente de Contas Técnico para mais informações). Esse token usa o mecanismo de autenticação básica HTTP. Você precisa fornecer um cabeçalho de autorização que contenha uma sequência codificada em base64 da sua chave de API e do seu segredo compartilhado.

Exemplo:

Authorization: Basic {api-key}:{shared-secret}

A chamada será feita para o ponto de extremidade do token documentado na especificação OpenAPI.

securitySchemes:
    oauth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://analytics.ean.com/template/v1/oauth/token

Uma chamada de autenticação válida vai retornar um token Bearer que você vai usar no próximo passo.

4.2 Faça uma solicitação à API usando o token

Usamos a autenticação com token Bearer para os pontos de extremidade transactions ou last_update. Você precisa fornecer um cabeçalho de autorização que contenha o token recebido no passo anterior.

Exemplo:

Authorization: Bearer {token}

4.3 Teste as suas solicitações

Depois de receber as suas credenciais e configurar a sua autenticação, você pode começar a enviar solicitações para o nosso ponto de extremidade de teste, https://test.analytics.ean.com/. Quaisquer dados retornados por meio desse ponto de extremidade são dados de amostra, e a sua única finalidade é compreender a estrutura dos dados.

Ao realizar testes, você precisa especificar a sua versão da API. Use o valor servers.url na especificação OpenAPI para construir o URL. Esses dois valores são padrão:

• Validação de integração: test.analytics.ean.com
• Ponto de extremidade de produção: analytics.ean.com

Observação: ao alternar entre pontos de extremidade, mantenha o protocolo e a designação do caminho (https://[test.]analytics.ean.com).

Exemplo:

https://test.analytics.ean.com/template/v1/loyalty/earn/last_update
https://test.analytics.ean.com/template/v1/itineraries

O valor servers.url é encontrado na parte superior dos nossos arquivos da especificação OpenAPI para download e sempre corresponde ao número da versão do serviço de API fornecido.

Exemplo:

openapi: 3.0.1
info:
  title: Analytics API
  description: Analytics API V1
  version: v1

tags:
  - name: Analytics
    description: Template Analytics API

servers:
  - url: https://analytics.ean.com/template/v1
  - url: https://test.analytics.ean.com/template/v1