Armazenamento de dados do usuário personalizado

Se você utiliza um armazenamento de dados de usuários personalizado, o Xsolla Login atuará como intermediário, e todos os dados de identificação de usuários será armazenado do seu lado. O Xsolla Login passa os dados de autenticação em um token incluso no cabeçalho dos webhooks e nos corpos deles.

Endereços de e-mail do usuário, dados de mídias sociais e atributos do usuário são armazenados no lado da Xsolla. As senhas não são armazenadas no lado da Xsolla.

Se você usa armazenamento personalizado, você tem acesso a:

autenticação de cadastro
autenticação via nome de usuário e senha
autenticação sem senha via número de telefone
autenticação sem senha via e-mail
autenticação via redes sociais
redefinição de senha de usuário

Se você está testando a integração localmente, solicitações POST da Xsolla não alcançam URLs como http://localhost:3000/my-webhook-endpoint. Ngrok permite que você crie um túnel para acessos externos, possibilitando o recebimento de solicitações da Xsolla localmente. Você pode ler mais sobre isso na documentação do ngrok.

Fluxo de interação

O cenário de interação depende do protocolo de autenticação escolhido: JWT ou OAuth 2.0.

Você pode usar o widget de login ou o seu aplicativo, que usa chamadas de Login API, como um cliente. O fluxo de interação entre o cliente e o servidor Xsolla Login é o seguinte:

O cliente envia solicitações para o servidor Xsolla Login. O formato de solicitações é descrito em Authentication methods.
O servidor Xsolla Login envia webhooks ao seu servidor. O cabeçalho inclui um JWT de servidor com o parâmetro “request_type”: “gateway_token”. Para configurar a validação de token, siga a instrução. Uma parte dos dados de identificação do usuário é passada no corpo do webhook.
Para confirmar o recebimento do webhook, seu servidor deve retornar:
- O código HTTP 200, 201, ou 204, em caso de uma resposta bem-sucedida.
- O código HTTP 400 com a descrição do problema, se o usuário especificado não foi encontrado ou se uma assinatura inválida foi passada. Seu gerenciador de webhooks também pode retornar um código HTTP 5xx em caso de problemas temporários com o servidor.

O servidor do Xsolla Login processa uma resposta a partir do seu servidor e retorna o token de autorização ao cliente.
O cliente envia a solicitação Generate JWT POST ao servidor do Xsolla Login. O corpo da solicitação deve incluir os seguintes parâmetros obrigatórios:
- grant_type — tipo de concessão JWT, passe o valor authorization_code.
- client_id — ID de Cliente OAuth 2.0.
- client_secret — ID de Cliente Secreto OAuth 2.0. Necessário para o tipo de autenticação confidencial.
- code — código de autorização.
O servidor Xsolla Login retorna um par de JWTs ao cliente: um token de acesso e um token de atualização.
O cliente processa a resposta.
Quando o token de acesso expira, o cliente envia a solicitação Generate JWT POST ao servidor Xsolla Login. O corpo da solicitação deve incluir os seguintes parâmetros obrigatórios:
- grant_type — tipo de concessão JWT, passe o valor refresh_token.
- client_id — ID de Cliente OAuth 2.0.
- refresh_token — o token de atualização recebido em resposta à solicitação de autorização do usuário.

Você pode adicionar as informações do usuário ao JWT ao identificar um usuário e/ou atualizar um token, e retornar um objeto JSON com qualquer conjunto de parâmetros no corpo de resposta. Esse objeto será salvo no campo partner_data do JWT.

O comprimento máximo do JSON com dados de usuário adicionais é de 1.000 caracteres.

Os seguintes dados podem ser adicionados às propriedades do perfil do usuário:

apelido
data de nascimento
nome
sobrenome
ID de usuário no seu servidor

Você também pode atualizar atributos de usuário passando uma matriz de objetos de atributos de usuário. A estrutura desses objetos está descrita abaixo.

Estrutura de um objeto de atributo de usuário:

Parâmetro	Tipo	Descrição
attr_type	string	Definição do nível de acesso do usuário aos atributos de serviço: `client` — Um atributo editável pelo usuário. Os valores para esse tipo de atributo são inseridos por um usuário ou especificados de acordo com as lógicas do jogo no lado do cliente. Por exemplo, o nome e as estatísticas do personagem, o nível de dificuldade do jogo, etc. (padrão) `server` — Um atributo somente leitura. Os valores para esse tipo de atributo são inseridos e editados no lado do servidor do seu aplicativo. Recomendamos que você os use para configurar estatísticas de personagens do jogo ou parâmetros de usuário que não devem ser alterados regularmente. Por exemplo, chance de obter um bônus, parâmetros chave de personagem do jogo, categorias de usuário, etc.
key	string	O nome do atributo usado para identificar o atributo do usuário. Deve ser exclusivo para cada usuário. Comprimento máximo: 256 símbolos. Você pode usar números, letras latinas, hifens e sublinhados.
permission	cadeia de caracteres ou null	O tipo de acesso aos atributos do usuário afeta a lista de atributos retornados pelos métodos: Get user’s attributes from client Get users by attribute from server Get user’s attributes from server Get user’s read-only attributes from server Possible values: `public`, `private`(padrão).
read_only	string	Se o atributo está protegido contra modificações ou não. Por padrão, `false` e alterar os valores do atributo é permitido.
value	string	O valor do atributo do usuário. Comprimento máximo: 256 símbolos.

Cadastro de usuários

O cenário de interação depende do protocolo de autenticação escolhido: JWT ou OAuth 2.0.

O cliente envia a solicitação Register new user POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na Conta de Distribuidor.
- Parâmetros do corpo:
  - username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
  - password — senha do usuário. Comprimento permitido: 6 a 100 caracteres.
  - email — endereço de e-mail do usuário. Comprimento permitido: 1 a 255 caracteres.
O servidor de Xsolla Login envia uma solicitação para o URL de novo usuário. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.

O cliente envia a solicitação Register new user POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na conta de jogos móveis.
- Parâmetros do corpo:
  - username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
  - password — senha do usuário. Comprimento permitido: 6 a 100 caracteres.
  - email — endereço de e-mail do usuário. Comprimento permitido: 1 a 255 caracteres.
O servidor de Xsolla Login envia uma solicitação para o URL de novo usuário. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.

O cliente envia a solicitação Register new user POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- Parâmetros do corpo:
  - username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
  - password — senha do usuário. Comprimento permitido: 6 a 100 caracteres.
  - email — endereço de e-mail do usuário. Comprimento permitido: 1 a 255 caracteres.
O servidor Xsolla Login envia um webhook para o New user URL. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido na resposta é registrado no campo partner_data do JWT do usuário.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Exemplo de webhook:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_registration_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"[email protected]",
7  "password":"123456",
8  "username":"[email protected]"
9}

1curl --request POST \
2  --url 'https://your.hostname/your_registration_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email":"[email protected]","password":"123456","username":"[email protected]"}'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Os dados do usuário serão registrados no banco de dados Xsolla enquanto o email estiver sinalizado como não confirmado. O usuário receberá um e-mail de confirmação de conta.
Se você integrou o Login Widget, o usuário será redirecionado à página com a seguinte mensagem: Confirme sua conta seguindo as instruções enviadas para {email}.
Se o cadastro do usuário não for bem sucedido, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe um objeto de error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Exemplo de um objeto com uma mensagem de erro:

Copy

Full screen

Small screen

1{
2  "error": {
3    "code": "011-002",
4    "description": "<string>"
5  }
6}

O cliente envia a solicitação Register new user POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- Parâmetros de pesquisa:
  - response_type — Tipo de conessão JWT, passe o valor code.
  - client_id — ID de Cliente OAuth 2.0.
  - state — um valor usado para autenticações de usuário adicionais. Necessário para prevenir ataques CSRF. Retornado na resposta. Comprimento permitido: 1 a 8 caracteres.
- Parâmetros do corpo:
  - username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
  - password — senha do usuário. Comprimento permitido: 6 a 100 caracteres.
O servidor de Xsolla Login envia um webhook ao URL de verificação de usuário. A resposta deve estar no formato descrito neste fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Exemplo de webhook:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_registration_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"[email protected]",
7  "password":"123456",
8  "username":"[email protected]"
9}

1curl --request POST \
2  --url 'https://your.hostname/your_registration_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email":"[email protected]","password":"123456","username":"[email protected]"}'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Os dados do usuário serão registrados no banco de dados Xsolla enquanto o email estiver sinalizado como não confirmado. O usuário receberá um e-mail de confirmação de conta.
Se você integrou o Login Widget, o usuário será redirecionado à página com a seguinte mensagem: Confirme sua conta seguindo as instruções enviadas para {email}.
Se o cadastro do usuário não for bem sucedido, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe um objeto de error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Exemplo de um objeto com uma mensagem de erro:

Copy

Full screen

Small screen

1{
2  "error": {
3    "code": "011-002",
4    "description": "<string>"
5  }
6}

Autenticação via nome de usuário e senha

O cenário de interação depende do protocolo de autenticação escolhido: JWT ou OAuth 2.0.

O cliente envia a solicitação Auth by username and password POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na Conta de Distribuidor.
- Parâmetros do corpo:
  - username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
  - password — senha do usuário. Comprimento permitido: 6 a 100 caracteres.
O servidor de Xsolla Login envia uma solicitação para o URL de verificação de usuário. A resposta deve estar no formato descrito neste fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.

O cliente envia a solicitação Auth by username and password POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na conta de jogos móveis.
- Parâmetros do corpo:
  - username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
  - password — senha do usuário. Comprimento permitido: 6 a 100 caracteres.
O servidor de Xsolla Login envia uma solicitação para o URL de verificação de usuário. A resposta deve estar no formato descrito neste fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.

O cliente envia a solicitação Auth by username and password POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- Parâmetros do corpo:
  - username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
  - password — senha do usuário. Comprimento permitido: 6 a 100 caracteres.
O servidor Xsolla Login envia um webhook para o User verification URL. A resposta deve estar no formato descrito neste fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido na resposta é registrado no campo partner_data do JWT do usuário.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Exemplo de webhook de URL de verificação de usuário:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"[email protected]",
7  "password":"123456",
8  "username":"[email protected]"
9}

1curl --request POST \
2  --url 'https://your.hostname/your_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email":"[email protected]","password":"123456","username":"[email protected]"}'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.
O servidor Xsolla Login gerará um JWT de usuário.
O usuário será redirecionado para o login_url com um parâmetro de pesquisa token. O parâmetro token contém o JWT do usuário.

Um novo usuário será criado se não houver dados de usuário gravados no banco de dados Xsolla.

O cliente envia a solicitação Auth by username and password POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- Parâmetros de pesquisa:
  - response_type — Tipo de concessão JWT, passe o valor code.
  - client_id — ID de Cliente OAuth 2.0.
  - state — um valor usado para autenticações de usuário adicionais. Necessário para prevenir ataques CSRF. Retornado na resposta. Comprimento permitido: 1 a 8 caracteres.
- Parâmetros do corpo:
  - username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
  - password — senha do usuário. Comprimento permitido: 6 a 100 caracteres.
O servidor de Xsolla Login envia um webhook ao URL de verificação de usuário. A resposta deve estar no formato descrito neste fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Exemplo de webhook de URL de verificação de usuário:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"[email protected]",
7  "password":"123456",
8  "username":"[email protected]"
9}

1curl --request POST \
2  --url 'https://your.hostname/your_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email":"[email protected]","password":"123456","username":"[email protected]"}'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.
O servidor Xsolla Login gerará um JWT de usuário.
O usuário será redirecionado para o login_url com um parâmetro de pesquisa token. O parâmetro token contém o JWT do usuário.

Um novo usuário será criado se não houver dados de usuário gravados no banco de dados Xsolla.

Autenticação sem senha via número de telefone

O cenário de interação depende do protocolo de autenticação escolhido: JWT ou OAuth 2.0.

O cliente abre um formulário de autenticação para que o usuário possa inserir seu número de telefone.
O usuário insere o número de telefone.
O cliente envia a solicitação Start auth by phone number POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na Conta de Distribuidor.
- O parâmetro do corpo phone_number — número de telefone do usuário.
O cliente exibe um campo para que o usuário possa preencher o código de verificação.
O usuário insere o código de verificação recebido.

O cliente envia a solicitação Complete auth by phone number POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na Conta de Distribuidor.
- Parâmetros do corpo:
  - username — código de confirmação.
  - phone_number — número de telefone do usuário.
  - operation_id — ID do código de confirmação.
Se esta for a primeira autorização do usuário, o servidor de Xsolla Login envia uma solicitação para o URL de login sem senha. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.
Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

O cliente abre um formulário de autenticação para que o usuário possa inserir seu número de telefone.
O usuário insere o número de telefone.
O cliente envia a solicitação Start auth by phone number POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na conta de jogos móveis.
- O parâmetro do corpo phone_number — número de telefone do usuário.
O cliente exibe um campo para que o usuário possa preencher o código de verificação.
O usuário insere o código de verificação recebido.

O cliente envia a solicitação Complete auth by phone number POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na conta de jogos móveis.
- Parâmetros do corpo:
  - username — código de confirmação.
  - phone_number — número de telefone do usuário.
  - operation_id — ID do código de confirmação.
Se esta for a primeira autorização do usuário, o servidor de Xsolla Login envia uma solicitação para o URL de login sem senha. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.
Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

O cliente abre um formulário de autenticação para que o usuário possa inserir seu número de telefone.
O usuário insere seu número de telefone.
O cliente envia a solicitação Start auth by phone number POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- O parâmetro do corpo phone_number — número de telefone do usuário.
O cliente exibe um campo para que o usuário possa preencher o código de verificação.
O usuário insere o código de verificação recebido.

O cliente envia a solicitação Complete auth by phone number POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- Parâmetros do corpo:
  - code — código de confirmação.
  - phone_number — número de telefone do usuário.
  - operation_id — ID do código de confirmação.
Se esta for a primeira autorização do usuário, o servidor Xsolla Login envia um webhook para o Passwordless login URL. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido na resposta é registrado no campo partner_data do JWT do usuário.
Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, por exemplo 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Exemplo de webhook:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_phone_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "login": "+12025550140",
7  "type": "phone"
8}

1curl --request POST \
2  --url 'https://your.hostname/your_phone_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"login":"+12025550140","type":"phone"}'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

O cliente abre um formulário de autenticação para que o usuário possa inserir seu número de telefone.
O usuário insere o número de telefone.
O cliente envia a solicitação Start auth by phone number POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- Parâmetros de pesquisa:
  - response_type — tipo de concessão JWT, passe o valor code.
  - client_id — ID de Cliente OAuth 2.0.
  - state — um valor usado para autenticação de usuário adicional. Necessário para prevenir ataques CSRF. Retornado na resposta. Comprimento permitido: 1 a 8 caracteres.
- O corpo do parâmetro phone_number — o endereço de e-mail do usuário.
O cliente mostra um campo para o usuário preencher o código de confirmação.
O usuário insere o código de verificação recebido.

O cliente envia a solicitação Complete auth by phone number POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa client_id —OAuth 2.0 client ID.
- Parâmetros do corpo:
  - code — código de confirmação.
  - phone_number — número de telefone do usuário.
  - operation_id — ID do código de confirmação.
Se esta for a primeira autorização do usuário, o servidor de Xsolla Login envia uma solicitação para o URL de login sem senha. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.
Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Exemplo de webhook:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_phone_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "login": "+12025550140",
7  "type": "phone"
8}

1curl --request POST \
2  --url 'https://your.hostname/your_phone_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"login":"+12025550140","type":"phone"}'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Autenticação sem senha via e-mail

O cenário de interação depende do protocolo de autenticação escolhido: JWT ou OAuth 2.0.

O cliente abre um formulário de autenticação para que o usuário possa inserir seu endereço de e-mail.
O usuário insere o endereço de e-mail.
O cliente envia a solicitação Start auth by email POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na Conta de Distribuidor.
- O parâmetro do corpo email — endereço de e-mail do usuário.
O cliente exibe um campo para que o usuário possa preencher o código de verificação.
O usuário insere o código de verificação recebido.

O cliente envia a solicitação Complete auth by email POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na Conta de Distribuidor.
- Parâmetros do corpo:
  - code — código de confirmação.
  - email — número de telefone do usuário.operation_id — ID do código de confirmação.
Se esta for a primeira autorização do usuário, o servidor de Xsolla Login envia uma solicitação para o URL de login sem senha. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.
Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

O cliente abre um formulário de autenticação para que o usuário possa inserir seu endereço de e-mail.
O usuário insere o endereço de e-mail.
O cliente envia a solicitação Start auth by email POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na conta de jogos móveis.
- O parâmetro do corpo email — endereço de e-mail do usuário.
O cliente exibe um campo para que o usuário possa preencher o código de verificação.
O usuário insere o código de verificação recebido.

O cliente envia a solicitação Complete auth by email POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na conta de jogos móveis.
- Parâmetros do corpo:
  - code — código de confirmação.
  - email — número de telefone do usuário.operation_id — ID do código de confirmação.
Se esta for a primeira autorização do usuário, o servidor de Xsolla Login envia uma solicitação para o URL de login sem senha. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.
Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

O cliente abre um formulário de autenticação para que o usuário possa inserir seu endereço de e-mail.
O usuário insere seu endereço de e-mail.
O cliente envia a solicitação Start auth by email POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- O parâmetro do corpo email — endereço de e-mail do usuário.
O cliente exibe um campo para que o usuário possa preencher o código de verificação.
O usuário insere o código de verificação recebido.

O cliente envia a solicitação Complete auth by email POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- Parâmetros do corpo:
  - code — código de confirmação.
  - email — endereço de e-mail do usuário.
  - operation_id — ID do código de confirmação.
Se esta for a primeira autorização do usuário, o servidor Xsolla Login envia um webhook para o Passwordless login URL. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido na resposta é registrado no campo partner_data do JWT do usuário.
Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, por exemplo 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Exemplo de webhook:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_email_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email": "[email protected]",
7  "type": "email"
8}

1curl --request POST \
2  --url 'https://your.hostname/your_email_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email": "[email protected]","type": "email"}'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

O cliente abre um formulário de autenticação para que o usuário possa inserir seu endereço de e-mail.
O usuário insere o endereço de e-mail.
O cliente envia a solicitação Start auth by email POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- Parâmetros de pesquisa:
  - response_type — tipo de concessão JWT, passe o valor code.
  - client_id — ID de Cliente OAuth 2.0.
  - state — um valor usado para autenticação de usuário adicional. Necessário para prevenir ataques CSRF. Retornado na resposta. Comprimento permitido: 1 a 8 caracteres.
- O corpo do parâmetro email — o endereço de e-mail do usuário.
O cliente mostra um campo para o usuário preencher o código de confirmação.
O usuário insere o código de verificação recebido.

O cliente envia a solicitação Complete auth by email POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa client_id —OAuth 2.0 client ID.
- Parâmetros do corpo:
  - code — código de confirmação.
  - phone_number — e-mail do usuário.
  - operation_id — ID do código de confirmação.
Se esta for a primeira autorização do usuário, o servidor de Xsolla Login envia uma solicitação para o URL de login sem senha. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.
Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Exemplo de webhook:

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_email_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email": "[email protected]",
7  "type": "email"
8}

1curl --request POST \
2  --url 'https://your.hostname/your_email_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email": "[email protected]","type": "email"}'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Autenticação via redes sociais

O cenário de interação depende do protocolo de autenticação escolhido: JWT ou OAuth 2.0.

Para obter dados do usuário ao autenticar via redes sociais, especifique o Social Login URL nas configurações do seu projeto Login na Conta de Distribuidor (seção User database > Storage > Custom storage). Uma solicitação com dados recebidos da rede social é enviada para esse URL.

Fluxo de autenticação:

O cliente envia a solicitação Auth via social network POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na Conta de Distribuidor.
- O parâmetro de trajeto provider_name — nome da rede social conectada ao Login na Conta de Distribuidor. Pode ser: amazon, apple, xsolla, baidu, battlenet, discord, epicgames, facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, xbox, yahoo, yandex, youtube.
O usuário acessa uma rede social.
O servidor Xsolla Login processa os dados de usuário recebidos da rede social e envia um webhook para o URL de login social. A resposta deve estar no formato descrito no fluxo de integração. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON que você fornecer na resposta é gravado no campo partner_data do JWT do usuário.

Para obter dados do usuário ao autenticar via redes sociais, especifique o Social Login URL nas configurações do seu projeto Login na conta de jogos móveis (seção User database > Storage > Custom storage). Uma solicitação com dados recebidos da rede social é enviada para esse URL.

Fluxo de autenticação:

O cliente envia a solicitação Auth via social network POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de pesquisa projectId — ID do projeto Login na conta de jogos móveis.
- O parâmetro de trajeto provider_name — nome da rede social conectada ao Login na conta de jogos móveis. Pode ser: amazon, apple, xsolla, baidu, battlenet, discord, epicgames, facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, xbox, yahoo, yandex, youtube.
O usuário acessa uma rede social.
O servidor Xsolla Login processa os dados de usuário recebidos da rede social e envia um webhook para o URL de login social. A resposta deve estar no formato descrito no fluxo de integração. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON que você fornecer na resposta é gravado no campo partner_data do JWT do usuário.

Para obter dados do usuário ao autenticar via redes sociais, especifique o Social Login URL nas configurações do seu projeto Login na conta (seção User database > Storage > Custom storage). Uma solicitação com dados recebidos da rede social é enviada para esse URL.

Fluxo de autenticação:

O cliente envia a solicitação Auth via social network POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- O parâmetro de caminho provider_name — nome da rede social conectada ao Login na sua conta. Pode ser: amazon, apple, xsolla, baidu, battlenet, discord, epicgames, facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, xbox, yahoo, yandex, youtube.
O usuário faz login em uma rede social.
O servidor Xsolla Login processa os dados do usuário recebidos da rede social e envia um webhook para o Social Login URL. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON que você fornecer na resposta é gravado no campo partner_data do JWT do usuário.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Os dados do usuário são passados no cabeçalho Authorization como token de portal temporário (um token de servidor com “request_type”: “gateway_token”.

Principais campos do token de portal:

Reivindicar	Tipo	Descrição
exp	Carimbo de data/hora Unix	A data e a hora do vencimento do JWT. A vida útil do JWT é de 7 minutos. Obrigatório.
iat	Carimbo de data/hora Unix	A data e a hora em que o JWT é emitido. Obrigatório.
iss	string	O serviço que assinou o JWT: `https://login.xsolla.com`. Obrigatório.
request_type	string	Constante: `gateway_request`. Obrigatório.
xsolla_login_project_id	cadeia de caracteres (UUID)	Seu ID de projeto de Login na Conta de Distribuidor. Obrigatório.
email	string	Endereço de e-mail do usuário.
sub	cadeia de caracteres (UUID)	ID do usuário escrito no lado do servidor Xsolla Login. Obrigatório.
username	string	Nome de usuário.
provider	string	Nome de uma rede social usada para autenticação. Obrigatório.
id	string	ID de usuário em uma rede social. Obrigatório.
social_access_token	string	Token de acesso da rede social pela qual o usuário fez a autenticação. Para ativar a transmissão dessa reivindicação, entre em contato com seu Gerente de Sucesso do Cliente ou envie um e-mail para [email protected].
partner_data	string	Dados de qualquer tipo são retornados pelo seu servidor no corpo de resposta durante a autenticação. Para habilitar a transmissão dessa reivindicação, contate seu Gerente de Sucesso do Cliente ou envie um e-mail para [email protected].

Reivindicar	Tipo	Descrição
exp	Carimbo de data/hora Unix	A data e a hora do vencimento do JWT. A vida útil do JWT é de 7 minutos. Obrigatório.
iat	Carimbo de data/hora Unix	A data e a hora em que o JWT é emitido. Obrigatório.
iss	string	O serviço que assinou o JWT: `https://login.xsolla.com`. Obrigatório.
request_type	string	Constante: `gateway_request`. Obrigatório.
xsolla_login_project_id	cadeia de caracteres (UUID)	Seu ID de projeto de Login na conta. Obrigatório.
email	string	Endereço de e-mail do usuário.
sub	cadeia de caracteres (UUID)	ID do usuário escrito no lado do servidor Xsolla Login. Obrigatório.
username	string	Nome de usuário.
provider	string	Nome de uma rede social usada para autenticação. Obrigatório.
id	string	ID de usuário em uma rede social. Obrigatório.
social_access_token	string	Token de acesso da rede social pela qual o usuário fez a autenticação. Para ativar a transmissão dessa reivindicação, entre em contato com seu Gerente de Sucesso do Cliente ou envie um e-mail para [email protected].
partner_data	string	Dados de qualquer tipo são retornados pelo seu servidor no corpo de resposta durante a autenticação. Para habilitar a transmissão dessa reivindicação, contate seu Gerente de Sucesso do Cliente ou envie um e-mail para [email protected].

Exemplo de uma carga útil de token:

Copy

Full screen

Small screen

 1{
 2  "exp": 1573635020,
 3  "iat": 1573634600,
 4  "iss": "https://login.xsolla.com",
 5  "request_type": "gateway_request",
 6  "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000",
 7  "sub": "00000000-0000-0000-0000-000000000000",
 8  "email": "[email protected]",
 9  "username": "Smith707",
10  "provider": "google",
11  "id": "123",
12}

Exemplo de webhook de URL de login social:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_social_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{}

1curl --request POST \
2  --url 'https://your.hostname/your_social_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Fluxo de autenticação:

O cliente envia a solicitação Auth via social network POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- Parâmetros de pesquisa:
  - response_type — tipo de concessão JWT, passe o valor code.
  - client_id — OAuth 2.0 client ID.
  - state — um valor usado para identificação de usuário adicional. Necessário para prevenir ataques CSRF. Retornado na resposta. Comprimento permitido: 1 a 8 caracteres.
- O parâmetro de trajeto provider_name — nome da rede social conectada ao Login na Conta de Distribuidor. Pode ser: amazon, apple, xsolla, baidu, battlenet, discord, epicgames, facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, xbox, yahoo, yandex, youtube.
O usuário acessa uma rede social.
O servidor Xsolla Login processa os dados de usuário recebidos da rede social e envia um webhook para o URL de login social. A resposta deve estar no formato descrito no fluxo de integração. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON que você fornecer na resposta é gravado no campo partner_data do JWT do usuário.

Fluxo de autenticação:

O cliente envia a solicitação Auth via social network POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- Parâmetros de pesquisa:
  - response_type — tipo de concessão JWT, passe o valor code.
  - client_id — OAuth 2.0 client ID.
  - state — um valor usado para identificação de usuário adicional. Necessário para prevenir ataques CSRF. Retornado na resposta. Comprimento permitido: 1 a 8 caracteres.
- O parâmetro de trajeto provider_name — nome da rede social conectada ao Login na conta de jogos móveis. Pode ser: amazon, apple, xsolla, baidu, battlenet, discord, epicgames, facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, xbox, yahoo, yandex, youtube.
O usuário acessa uma rede social.
O servidor Xsolla Login processa os dados de usuário recebidos da rede social e envia um webhook para o URL de login social. A resposta deve estar no formato descrito no fluxo de integração. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON que você fornecer na resposta é gravado no campo partner_data do JWT do usuário.

Fluxo de autenticação:

O cliente envia a solicitação Auth via social network POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- O parâmetro de caminho provider_name — nome da rede social conectada ao Login na sua conta. Pode ser: amazon, apple, xsolla, baidu, battlenet, discord, epicgames, facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, xbox, yahoo, yandex, youtube.
O usuário faz login em uma rede social.
O servidor Xsolla Login processa os dados do usuário recebidos da rede social e envia um webhook para o Social Login URL. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON que você fornecer na resposta é gravado no campo partner_data do JWT do usuário.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Os dados do usuário são passados no cabeçalho Authorization como token de portal temporário (um token de servidor com “request_type”: “gateway_token”.

Principais campos do token de portal:

Reivindicar	Tipo	Descrição
exp	Carimbo de data/hora Unix	A data e a hora do vencimento do JWT. A vida útil do JWT é de 7 minutos. Obrigatório.
iat	Carimbo de data/hora Unix	A data e a hora em que o JWT é emitido. Obrigatório.
iss	string	O serviço que assinou o JWT: `https://login.xsolla.com`. Obrigatório.
request_type	string	Constante: `gateway_request`. Obrigatório.
xsolla_login_project_id	cadeia de caracteres (UUID)	Seu ID de projeto de Login na Conta de Distribuidor. Obrigatório.
email	string	Endereço de e-mail do usuário.
sub	cadeia de caracteres (UUID)	ID do usuário escrito no lado do servidor Xsolla Login. Obrigatório.
username	string	Nome de usuário.
provider	string	Nome de uma rede social usada para autenticação. Obrigatório.
id	string	ID de usuário em uma rede social. Obrigatório.
social_access_token	string	Token de acesso da rede social pela qual o usuário fez a autenticação. Para ativar a transmissão dessa reivindicação, entre em contato com seu Gerente de Sucesso do Cliente ou envie um e-mail para [email protected].
partner_data	string	Dados de qualquer tipo são retornados pelo seu servidor no corpo de resposta durante a autenticação. Para habilitar a transmissão dessa reivindicação, contate seu Gerente de Sucesso do Cliente ou envie um e-mail para [email protected].

Reivindicar	Tipo	Descrição
exp	Carimbo de data/hora Unix	A data e a hora do vencimento do JWT. A vida útil do JWT é de 7 minutos. Obrigatório.
iat	Carimbo de data/hora Unix	A data e a hora em que o JWT é emitido. Obrigatório.
iss	string	O serviço que assinou o JWT: `https://login.xsolla.com`. Obrigatório.
request_type	string	Constante: `gateway_request`. Obrigatório.
xsolla_login_project_id	cadeia de caracteres (UUID)	Seu ID de projeto de Login na conta. Obrigatório.
email	string	Endereço de e-mail do usuário.
sub	cadeia de caracteres (UUID)	ID do usuário escrito no lado do servidor Xsolla Login. Obrigatório.
username	string	Nome de usuário.
provider	string	Nome de uma rede social usada para autenticação. Obrigatório.
id	string	ID de usuário em uma rede social. Obrigatório.
social_access_token	string	Token de acesso da rede social pela qual o usuário fez a autenticação. Para ativar a transmissão dessa reivindicação, entre em contato com seu Gerente de Sucesso do Cliente ou envie um e-mail para [email protected].
partner_data	string	Dados de qualquer tipo são retornados pelo seu servidor no corpo de resposta durante a autenticação. Para habilitar a transmissão dessa reivindicação, contate seu Gerente de Sucesso do Cliente ou envie um e-mail para [email protected].

Exemplo de uma carga útil de token:

Copy

Full screen

Small screen

 1{
 2  "exp": 1573635020,
 3  "iat": 1573634600,
 4  "iss": "https://login.xsolla.com",
 5  "request_type": "gateway_request",
 6  "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000",
 7  "sub": "00000000-0000-0000-0000-000000000000",
 8  "email": "[email protected]",
 9  "username": "Smith707",
10  "provider": "google",
11  "id": "123",
12}

Exemplo de webhook de URL de login social:

Copy

Full screen

Small screen

http

1POST https://your.hostname/your_social_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{}

1curl --request POST \
2  --url 'https://your.hostname/your_social_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json'

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Se a autenticação do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, como 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Redefinição de senha do usuário

O cliente envia a solicitação Reset password POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros obrigatórios:
- Parâmetro de pesquisa projectId — ID do projeto Login na Conta de Distribuidor.
- O parâmetro do corpo username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
O servidor Xsolla Login envia um webhook ao URL de redefinição de senha.
Se a redefinição de senha do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe um objeto de error com os seguintes detalhes:
- No parâmetro code, especifique 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

O cliente envia a solicitação Reset password POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros obrigatórios:
- Parâmetro de pesquisa projectId — ID do projeto Login na conta de jogos móveis.
- O parâmetro do corpo username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
O servidor Xsolla Login envia um webhook ao URL de redefinição de senha.
Se a redefinição de senha do usuário não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe um objeto de error com os seguintes detalhes:
- No parâmetro code, especifique 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

O cliente envia a solicitação Reset password POST ao servidor Xsolla Login. A solicitação deve incluir os seguintes parâmetros necessários:
- O parâmetro de consulta projectId — ID do projeto Login na sua conta.
- O parâmetro do corpo username — nome do usuário. Comprimento permitido: 3 a 255 caracteres.
O servidor Xsolla Login envia um e-mail de confirmação de redefinição de senha para o usuário.
Após confirmar a redefinição de senha no e-mail, o usuário é redirecionado para a página onde pode inserir uma nova senha.
O usuário insere uma nova senha.
O servidor Xsolla Login envia um webhook para o Password reset URL.
Se a redefinição de senha não for bem-sucedida, você poderá fornecer uma mensagem de erro que será exibida no widget de autenticação. Para fazer isso, na resposta à solicitação de criação do usuário, passe o objeto error com os seguintes detalhes:
- No parâmetro code, especifique um código de erro, por exemplo 011-002.
- No parâmetro description, forneça o texto da mensagem de erro.

Exemplo de webhook de URL de redefinição de senha:

Copy

Full screen

Small screen

http

 1POST https://your.hostname/your_reset_uri HTTP/1.1
 2Authorization: Bearer {JWT}
 3Content-Type: application/json
 4
 5{
 6  "username": "[email protected]",
 7  "fields": {
 8    "password": "NewPa$$word1"
 9  }
10}

1curl --request POST \
2  --url 'https://your.hostname/your_reset_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email":"[email protected]","fields":{"password":"NewPa$$word1"}}'

Atualização de token

A atualização de token fica disponível somente ao usar o protocolo de autenticação OAuth 2.0.

Quando o token de acesso expira, o cliente envia o ponto de extremidade da solicitação Generate JWT POST no servidor Xsolla Login. O corpo da solicitação deve incluir os seguintes parâmetros:
- grant_type — tipo de concessão JWT, passe o valor refresh_token.
- client_id — ID de Cliente OAuth 2.0.
- refresh_token — atualize o token recebido em resposta à solicitação de autorização do usuário.
O servidor de Xsolla Login processa os dados do usuário recebidos da rede social e envia um webhook para o URL de atualização de token. A resposta deve estar no formato descrito no fluxo de interação. Na resposta, você pode especificar uma lista de atributos de usuário e/ou qualquer objeto JSON necessário. O objeto JSON fornecido em resposta é registrado no campo partner_data do JWT do usuário.

Para mapear campos JSON às propriedades de perfil do usuário na Xsolla e configurar a vinculação de conta por ID de Usuário no seu servidor, siga a instrução.

Exemplo de webhook:

Copy

Full screen

Small screen

1POST https://your.hostname/your_refrsh_token_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{}

Exemplo de uma resposta a um webhook com atributos de usuário:

Copy

Full screen

Small screen

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemplo de uma resposta a um webhook com um objeto JSON:

Copy

Full screen

Small screen

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "[email protected]"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Obrigado pelo seu feedback!

Avaliaremos sua mensagem e a usaremos para melhorar sua experiência.

Continuar lendo

Links úteis

Como conectar o armazenamento personalizado JSON para o mapa de nome-chave de perfil do usuário

Última atualização: 28 de Agosto de 2026

Encontrou um erro de texto ou digitação? Selecione o texto e pressione Ctrl+Enter.

Conteúdos

Fluxo de interação
Cadastro de usuários
Autenticação via nome de usuário e senha
Autenticação sem senha via número de telefone
Autenticação sem senha via e-mail
Autenticação via redes sociais
Redefinição de senha do usuário
Atualização de token

Armazenamento de dados do usuário personalizado

Fluxo de interação

attr_type

key

permission

read_only

value

Cadastro de usuários

Autenticação via nome de usuário e senha

Autenticação sem senha via número de telefone

Autenticação sem senha via e-mail

Autenticação via redes sociais

Redefinição de senha do usuário

Atualização de token

Continuar lendo

Links úteis