Pontos de extremidade

Estes métodos e pontos de extremidade se aplicam a todas as solicitações de API, exceto se indicado de outra forma.

Observe que as solicitações de reserva devem ser enviadas em um ponto de extremidade seguro separado via POST.

Solicitações gerais: GET http://api.ean.com
Solicitações de reserva: POST https://book.api.ean.com
Parâmetros de solicitação comuns
A maioria desses parâmetros deve ser enviada como parte de toda solicitação que você faz à API. Alguns podem ser fornecidos para fins de teste ou são necessários apenas para configurações específicas.

Nome Valor Obrigatório Descrição
apiExperience string sim

Use esse atributo para identificar a origem de sua solicitação. Selecione um valor aplicável do conjunto fornecido abaixo para cada solicitação enviada.

Valores:
PARTNER_CALL_CENTER - solicitação de um agente na central de atendimento
PARTNER_WEBSITE - solicitação de um site direcionado aos clientes
PARTNER_MOBILE_WEB - solicitação de um site formatado para dispositivos móveis
PARTNER_MOBILE_APP - solicitação de um app para dispositivo móvel
PARTNER_BOT_CACHE - solicitação de um robô de cache
PARTNER_BOT_REPORTING - solicitação de um robô de relatório
PARTNER_AFFILIATE - solicitação de uma API/plataforma usada por sua própria base de afiliados

cid long sim

Sua ID de conta emitida pela EAN. Esse número é usado com a finalidade de acompanhar as vendas para fins de estatística e comissões em sites ativos.

Emparelhado com apiKey(s) como parte da autenticação.

apiKey string sim Sua chave de acesso à API emitida pela EAN. Determina seu acesso a reservas ativas, a cotas de solicitações e ao seu método de autenticação (IP ou baseado em assinatura).

Emparelhado com uma cid como parte da autenticação geral.
minorRev int sim Define a revisão secundária usada para processar solicitações e retornar respostas.
O padrão é 24 (versão mais antiga compatível) se omitida.
locale string sim Identifica o país do cliente e a nacionalidade do ponto de vendas usados na reserva. Consulte nossos locais compatíveis.

Padrão: en_US
currencyCode string não, somente para tipo de pagamento e reserva Retorna dados em outras moedas quando disponíveis.

Quando você reservar, esse valor deve corresponder ao valor retornado dentro do nó ChargeableRateInfo da resposta de disponibilidade de quartos anterior para evitar erros de incompatibilidade de preço.

Padrão: USD
customerSessionId string sim Insira o seu próprio valor exclusivo para cada cliente começando com a primeira pesquisa de lista de hotéis ou use o valor retornado na resposta da lista inicial para o restante do processo de reserva.

Continue passando esse mesmo valor para cada cliente durante cada sessão de reserva, usando um novo valor para cada nova sessão de cliente.

A inclusão desse valor facilita muito o processo de depuração interno da EAN para problemas com solicitações de parceiros porque ela reúne caminhos de solicitação para clientes individuais.

customerIpAddress string sim Endereço IP do cliente, conforme capturado pela sua integração. Envie endereços IPV4 somente.

Verifique se a sua integração passa o IP do cliente, e não o seu próprio. Este valor ajuda a determinar o local e atribuir o gateway de pagamento correto.

Também é usado para recuperação de fraude e outras análises importantes.
customerUserAgent string sim

A string do cabeçalho user-agent da solicitação do cliente, conforme capturada pela sua integração.

A API detectará o uso de um dispositivo móvel através dos conteúdos da string user-agent bruta.

No caso de tráfego de aplicativos para dispositivos móveis ou para desktop, use o seguinte formato:
{App Name}/{App Version} ({OS} {OS Version}) [APP or MOBILE_APP]

Exemplos:

TravelWizard/1.0 (iOS 10_10_3) MOBILE_APP
Explorer/2.1 (Windows 7) APP
Explorer/2.1 (Linux 2.6.32) APP

Preterido: Nos sites para dispositivos móveis, inclua o valor da string MOBILE_SITE em qualquer lugar dentro desse elemento. Use MOBILE_APP para apps para dispositivo móvel. Esses valores podem ser enviados sozinhos ou anexados a uma string de agente de cliente. Nota: O suporte ao MOBILE_SITE talvez seja removido no futuro.

Um navegador de desktop é utilizado quando não é detectada nenhuma das cadeias de caracteres de dispositivos móveis nem qualquer palavra-chave específica para dispositivos móveis.

sig string sim, se a autenticação SIG for usada O valor SIG usado com autenticação de assinatura. Certifique-se de que esse valor permaneça sem qualquer código visível.

Todos os valores sig devem ter pelo menos 32 caracteres minúsculos.

Se você receber erros ao gerar sua assinatura digital, envie uma solicitação de ping para conferir sua hora Unix em relação à da EAN ou verifique seu valor no gerador de sigs da EAN.