This is an auto-generated translation

Visão geral do SSO do OAuth 2.0

O OAuth 2.0 é uma estrutura de autorização que permite que aplicativos tenham acesso limitado a contas de usuários em um serviço HTTP. Ele funciona delegando a autenticação de usuário ao serviço que hospeda a conta de usuário e autorizando aplicativos de terceiros a acessar a conta de usuário. O OAuth 2.0 fornece fluxos de autorização a celulares ou tablets e aplicativos para desktop e web.

Saiba mais sobre o OAuth 2.0

SSO básico

Sejam quais forem as opções de recursos selecionadas, o SSO básico requer alguns dados específicos, em especial uma chave pública. Adicionar implementações de cartão de crédito ou programa de fidelidade exige mais informações.

Informações de configuração

Para configurar o acesso de SSO do OAuth 2.0 ao seu modelo de site, alguns elementos são necessários, incluindo:

  • APIs (autorização, token, userProfile)
  • ClientId
  • Segredo do cliente
  • ResponseMode
  • isNonceEnabled
  • customerDetailsAPIKey (se disponível)

Fluxos de autorização

OAuth Authorization flows

Endpoint de autorização

O ponto de extremidade GET /authorize é usado para autenticação e autorização. Retorna uma concessão de autorização ou código para o usuário da postagem do cliente, que é logged-in. É um redirecionamento do navegador.

CampoDescriçãoTipo de dadosExemplo do valorObrigatório?
client_idIdentifica o cliente. Deve corresponder ao valor pré-registrado no seu provedor de identidade (IDP). Obtido durante o registro manual do cliente ou por meio da API de registro dinâmico do cliente.Sequência Sim
nonceUsado para mitigar ataques de repetição. Esse valor é retornado no token de ID.Sequência Sim
promptO tipo de interação necessário para validação. Se estiver "vazio", o usuário deverá fazer login caso ainda não esteja autenticado. Se "nenhum", o IdP não solicitará login, mas retornará um código de autorização se o usuário estiver logado, ou um erro caso contrário.SequênciaValores válidos:
none
OU VAZIO
Não
redirect_uriLocal de callback para onde o código de autorização ou tokens devem ser enviados. Deve corresponder ao valor pré-registrado no seu IDP durante o registro do cliente.Sequência Sim
response_typeValor do code (IDP).Sequência Sim
response_modeComo a resposta de autorização deve ser retornada.SequênciaValor válido:
query
Não
scopeToken de acesso, usado para buscar detalhes de perfil. Obrigatório para solicitações de autenticação.SequênciaPerfil e e-mailSim
stateO estado da interação. Esse valor é retornado no token e permite que o usuário clique, faça a autenticação e retorne à página em que estava interessado. O valor pode conter caracteres alfanuméricos, vírgula, ponto, sublinhado e hífen.Sequência Sim
ui_localesIdiomas e scripts preferidos do usuário para a interface do usuário.Sequênciaen_CA, fr_CANão
audienceO destinatário pretendido.SequênciaDefinido pelos ParceirosNão

Parâmetros de resposta

ParâmetroDescriçãoTipo de dadosObrigatório?
codeCódigo de autorização que identifica o cliente. Deve corresponder ao valor pré-registrado no seu IDP. Obtido durante o registro manual do cliente ou por meio da API de registro dinâmico do cliente.SequênciaSim
stateO estado da interação. Esse valor é retornado no token e permite que o usuário clique, faça a autenticação e retorne à página em que estava interessado. O valor pode conter caracteres alfanuméricos, vírgula, ponto, sublinhado e hífen.SequênciaSim

Exemplo de URL de autorização

https://example.com/authorize?client_id={clientID}&response_type=code&state=d6b93799-404b-4205-9bb3-c579b1180428&scope=email profile&nounce=234567687867&redirect_uri=https://{ExpediaDomain}/sso/auth

URL de retorno de chamada de exemplo

https://{ExpediaDomain}/sso/auth?code=12345678&state=d6b93799-404b-4205-9bb3-c579b1180428

Endpoint de token

O endpoint POST /tokené uma chamada de API de backend usada para obter um token de acesso e um token de ID, apresentando uma concessão ou código de autorização.

Parâmetros de solicitação

ParâmetroDescriçãoTipo de dadosObrigatório?
grant_typeO mecanismo que o seu IDP usa para autorizar a criação dos tokens. Valor: authorization_code.SequênciaSim
redirect_uriEspecifica o local de callback para onde a autorização foi enviada. Esse valor deve corresponder ao redirect_uri usado para gerar o authorization_code original.SequênciaSim
codeCódigo de identificação do cliente recebido na resposta da chamada de /authorize.SequênciaSim

Cabeçalhos de solicitação

ParâmetroDescriçãoTipo de dadosExemplo do valorObrigatório?
acceptDeve ser "application/json".Sequênciaapplication/jsonSim
authorizationCodifica o ID e o segredo do cliente com Base64. Use as informações codificadas no cabeçalho de autorização HTTP.SequênciaBasic<Base64 encoded client ID and secret>Sim
Content-TypeDeve ser "application/x-www-form-urlencoded".Sequênciaapplication/x-www-form-urlencodedSim

Propriedades de resposta

CampoDescriçãoTipo de dados
access_tokenUm token de acesso.Sequência
token_typeO público do token.Sequência
expires_inO tempo de expiração do token de acesso em segundos.Inteiro
scopeOs escopos contidos no token de acesso.Sequência

Token de exemplo CURL

curl --location 'https://example.com/token’ \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic {encoded ClientID:clientSecret}' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'redirect_uri=https://{ExpediaDomain}/sso/auth’ \
--data-urlencode 'code={Authorization code after login as part of callback to Expedia /sso/auth endpoint}'

Exemplo de resposta do token

{
    "access_token": "eyJhbGciOi.JSUzI1NiIsImtpZCI6Ilk1MkFDVXd3QV9SUzI1NiIsInBp.LmF0bSI6ImlrY20ifQ",
    "token_type": "Bearer",
    "expires_in": 1799
}

Endpoint de informações do usuário

O endpoint GET /userinfo é uma chamada de API de backend que retorna informações sobre o usuário autenticado com base no token de acesso fornecido.

Cabeçalhos de solicitação

CampoDescriçãoTipo de dadosExemplo do valorObrigatório?
ClientIdIdentifica o cliente. Deve corresponder ao valor pré-registrado no seu provedor de identidade (IDP). Obtido durante o registro manual do cliente ou por meio da API de registro dinâmico do cliente.Sequência Sim
AuthorizationCabeçalho HTTP usado para enviar credenciais ou tokens para autenticar um usuário.SequênciaPortador [access_token]Sim

Resposta

CampoDescriçãoTipo de dadosExemplo do valorObrigatório?
membershipIdIdentificador que identifica exclusivamente a conta do Cliente.Sequência Sim
optInIndicador booleano que indica se o cliente optou por receber e-mails de marketing.Booleanoverdadeiro/falsoNão
languageIdIdioma preferido do usuárioSequênciaEm, frNão
channelTypeDiferentes plataformas através das quais um usuário interage com um aplicativoSequênciaWEB, CELULAR, TABLETNão
firstNamePrimeiro nome do clienteSequência Sim
middleNameNome do meio do clienteSequência Não
lastNameSobrenome do clienteSequência Não
emailEndereço de e-mail do clienteSequência Não
programAccountInformações Loyalty-relatedprogramAccountConsulte a seção Add loyalty -> programAccountabaixo para obter detalhes do objeto.Não

Exemplo de informações do usuário CURL

curl --location 'https://example.com/userinfo' \
--header 'client_id: {clientId}' \
--header 'Authorization: Bearer {acess_token from token endpoint}'

Exemplo de resposta de informações do usuário

{
  "membershipId": "12345678",
  "languageID": "en",
  "middleName": "MiddleName",
  "lastName": "LastName",
  "firstName": "FirstName",
  "email": "test@expediagroup.com",
  "programAccount": {
    "programId": "Gold",
    "loyaltyAccountBalance": {
      "value": "10000",
      "currency": "Points"
    }
  }
}

Inclusão de programas de fidelidade

Como parte do seu modelo de site, você pode incluir a possibilidade de os clientes ganharem pontos de fidelidade em suas compras de viagens. Se desejar, seu modelo também pode permitir que os clientes use seus pontos de fidelidade acumulados para comprar viagens.

Os mesmos requisitos de configuração da implementação padrão se aplicam, assim como muitos dos valores. Somente os que são diferentes estão incluídos aqui.

Além dos valores padrão user information, a configuração do programa de fidelidade incluirá os seguintes valores.

programAccount

CampoDescriçãoTipo de dadosObrigatório?
programIdIdentificador do programa de fidelidade ao qual o cliente é afiliado ou o nome do nível associado ao programa de fidelidade.SequênciaSim
loyaltyAccountNumberNúmero da conta do programa de fidelidade do cliente. Deve ser preenchido somente se um identificador secundário, diferente do membershipId exclusivo, for necessário para operações do programa de fidelidade.SequênciaNão
lastFourDigitsOfCreditCardÚltimos quatro dígitos do cartão de crédito que o cliente usou na reserva.InteiroNão
accountNameNome do programa (se diferente do nome do nível).SequênciaNão
loyaltyConversionRatioProporção usada para converter o pagamento em pontos ganhos, por exemplo, R$ 1 = 1 ponto.DuploNão
loyaltyAccountBalanceSaldo atual dos pontos de fidelidade ganhos pelo cliente.Valor
(Consulte a seção Valor abaixo para obter detalhes do objeto)
Não

Valor

CampoDescriçãoTipo de dadosObrigatório?
valueSaldo do programa de fidelidade, aninhado em loyaltyAccountBalance.LongaSim
currencyA moeda usada pelo programa de fidelidade, por exemplo, reais, dólares americanos, pontos ou milhas, aninhada em loyaltyAccountBalance.SequênciaSim
Esta página foi útil?
Como podemos melhorar esse conteúdo?
Agradecemos por nos ajudar a melhorar.