• Versão: 1.0.0
• Servidores: https://login.xsolla.com/api
• Protocolos: https
• Aceita: application/json
• Responde com: application/json
• Entre em contato conosco por e-mail
• URL de contato: https://xsolla.com/

Esta seção descreve as chamadas de API para trabalhar com Login. Configure seu projeto Login na Conta de Distribuidor antes de enviar solicitações.

The full list of IP addresses that login.xsolla.com may use:

• 34.94.0.85
• 34.94.14.95
• 34.94.25.33
• 34.94.115.185
• 34.94.154.26
• 34.94.173.132
• 34.102.48.30
• 35.235.99.248
• 35.236.32.131
• 35.236.35.100
• 35.236.117.164

Você pode baixar a definição de API em dois formatos:

• YAML
• JSON

Você tem acesso aos seguintes tipos de projeto Login na Conta de Distribuidor:

• Projeto Login padrão
• Projeto Shadow Login

Para obter mais informações sobre ele, consulte o recurso Conta multiplataforma.

São as restrições aplicadas pela API Xsolla sobre a frequência de acesso por um usuário dentro de um período de tempo definido.

É um projeto Login usado para armazenar contas principais.

É um projeto Login usado para armazenar contas de plataforma.

É um tipo de conta criado em um projeto Login padrão e vinculado a contas de plataforma. A conta principal é usada para identificar o jogador em diferentes plataformas.

É um tipo de conta criado em um projeto de Login sombra e conectado a uma plataforma de distribuição definida. A conta da plataforma não pode ser vinculada a outra conta da plataforma. Além disso, não é possível desvincular as contas de uma conta principal.

É uma plataforma de jogos que é usada para a distribuição de jogos (por exemplo, Steam, PlayStation, Xbox, etc.).

A Login API oferece suporte aos seguintes tipos de token:

• Token de usuário. Ele é usado para enviar solicitações para os seguintes recursos do usuário:
  • perfil
  • amigos
  • atributos
• Token de servidor. Ele é usado para enviar solicitações para recursos do aplicativo, como configurações ou dados do usuário. As seguintes solicitações estão disponíveis:
  • Criar contas de plataforma
  • Obter dados do usuário
  • Vincular contas
  • Vincular contas de usuário via ID externo

Você pode determinar se uma chamada de API ocorre no lado do cliente ou do servidor pelo esquema de autenticação:

• Client-side — are called without authentication or with the Authorization header: Bearer <user_JWT> header, where <user_JWT> — is the user token.
• Server-side API calls for implementing the user flow — are called with the header: X-SERVER-AUTHORIZATION: <server_JWT>, where <server_JWT> — is the server token.

Para obter o token, envie uma das seguintes solicitações:

• registro de usuário (JWT ou OAuth 2.0)
• autenticação por nome de usuário e senha (autenticação JWT, OAuth 2.0 ou JWT por nome de usuário e senha)
• autenticação via redes sociais (JWT ou OAuth 2.0)
• autenticação silenciosa (JWT ou OAuth 2.0)
• Autenticação por meio de um token de acesso à rede social
• autenticação através de uma plataforma de publicação

Após a autenticação JWT, o usuário é redirecionado para o URL de retorno de chamada com um token em um parâmetro de consulta: <Callback URL>?token=<User token (JWT)>.

Após a autenticação baseada no protocolo OAuth 2.0, envie a solicitação Generate JWT ao servidor do Xsolla Login para trocar o parâmetro code recebido por um token de usuário (access_token).

Para obter um token de servidor:

1. Configure o cliente OAuth 2.0 do servidor.
2. Gere o JWT do servidor.

Configure o cliente OAuth 2.0 do servidor

1. Abra seu projeto na Conta de Distribuidor e vá para a seção Login.
2. Clique em Configure no painel de um projeto Login.
3. Vá para o bloco Security e selecione a seção OAuth 2.0.
4. Clique em Adicionar cliente OAuth 2.0.
5. Marque a caixa Server (server-to-server connection).
6. Especifique o Tempo de vida do token.
7. Clique em Connect.
8. Copie e salve o ID do cliente e a chave secreta.

Geração do JWT do servidor

No back-end do seu aplicativo, implemente um método para obter o JWT do servidor usando a chamada Generate JWT API. A solicitação deve conter os seguintes parâmetros:

• grant_type é o tipo de obtenção de JWT; passa o valor client_credentials.
• client_secret é a chave secreta que é recebida quando você configura o cliente OAuth 2.0 do servidor.
• client_id é o ID do cliente recebido quando você configura o cliente OAuth 2.0 do servidor.

Para evitar sobrecarregar o sistema Xsolla e proteger contra picos repentinos no tráfego de entrada, a Xsolla limita o número de solicitações recebidas pela API Xsolla dentro de um período de tempo especificado. Se o limite for excedido, a API Xsolla retornará uma resposta HTTP com o código de status 429.

Rate limits vary by method, IP-address, authentication scheme, and other factors.

Rate limits for server-side methods are applied to methods with server-side authentication — methods that are called with the X-SERVER-AUTHORIZATION: <server_JWT> header, where <server_JWT> is the server token.

Rate limits for client-side methods are applied to methods without authentication or with client-side authentication — methods that are called with the Authorization: Bearer <user_JWT> header, where <user_JWT> is the user token.

Example of a method with server-side authentication: Example of a method with client-side authentication:

Os limites de taxa para métodos do lado do cliente não mudam e são necessários para evitar ataques de força bruta. A taxa máxima de solicitação para métodos do lado do servidor é maior do que para métodos do lado do cliente. Você pode consultar as recomendações sobre como gerenciar limites de taxa na documentação.

Cada token tem um formato JWT e contém uma informação definida em uma carga.

O JWT do usuário é um token recebido como resultado da autenticação ou cadastro. Uma carga de token contém informações sobre o usuário e a chamada de autenticação.

Para obter um token de usuário por meio do protocolo OAuth 2.0, você precisa de um cliente OAuth 2.0. O token de usuário é passado no cabeçalho Authorization: Bearer <JWT>.

Um token conterá as principais declarações após a autenticação ou confirmação do endereço de e-mail. A presença dessas declarações não depende do banco de dados do usuário e da chamada de autenticação.

Declarações contidas no token após a autenticação se você usar o armazenamento PlayFab.

Declarações contidas no token após a autenticação se você usar armazenamento personalizado.

Declarações que estão contidas no token após a autenticação por meio de uma rede social. A presença dessas declarações não depende do banco de dados do usuário.

Declarações contidas no token após a autenticação do OAuth 2.0.

Reivindicação que está contida no token após a autenticação por meio de um número de telefone.

O token do servidor é passado no cabeçalho X-SERVER-AUTHORIZATION.

A carga do token contém informações sobre recursos pertencentes ao cliente OAuth 2.0. O token tem acesso a chamadas com autenticação baseada em servidor para esses recursos.

Após a autenticação bem-sucedida, cada usuário recebe um JWT gerado para ele. O JWT gerado é assinado por uma chave secreta. Para certificar-se de que um JWT é relevante e pertence ao usuário do seu projeto Login, você deve validar seu valor.

Para validar um JWT:

1. Abra seu projeto na Conta de Distribuidor e vá para a seção Login.
2. Clique em Configure no painel de uma opção Login.
3. Na página de navegação, vá para o bloco Security e selecione a seção JWT Signature.
4. Selecione seu método de criptografia e copie o valor do campo Secret key ou New public JSON Web Key, dependendo do método selecionado.
5. Escolha a biblioteca e conecte-a no lado do servidor do seu aplicativo.
6. Passe o valor, copiado no passo 4, para a entrada da função de validação.

Em caso de respostas de erro, o servidor do Xsolla Login retorna um objeto JSON com os seguintes campos:

{
  "error": {
    "code": "000-000",
    "description": "description"
  }
}