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:

1. O cliente envia solicitações para o servidor Xsolla Login. O formato de solicitações é descrito em Authentication methods.
2. 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.
3. 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.
4. O servidor Xsolla Login processa uma resposta do seu servidor e retorna o token de autorização para o cliente.
5. O cliente processa a resposta.

Se você quiser adicionar informações de usuários ao JWT após a identificação do usuário, retorne um objeto JSON com qualquer conjunto de parâmetros no corpo de resposta. Esse objeto será salvo no campo partner_data do JWT.

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:

1. O cliente envia solicitações para o servidor Xsolla Login. O formato de solicitações é descrito em Authentication methods.
2. 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.
3. 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.

5. O servidor do Xsolla Login processa uma resposta a partir do seu servidor e retorna o token de autorização ao cliente.
6. 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.
7. O servidor Xsolla Login retorna um par de JWTs ao cliente: um token de acesso e um token de atualização.
8. O cliente processa a resposta.
9. 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.

1. 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.
2. 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.

Exemplo de webhook:

1POST https://your.hostname/your_registration_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"j.smith@email.com",
7  "password":"123456",
8  "username":"j.smith@email.com"
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":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'

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

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

3. 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.
4. 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}.
5. 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:

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

1. 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.
2. 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.

Exemplo de webhook:

1POST https://your.hostname/your_registration_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"j.smith@email.com",
7  "password":"123456",
8  "username":"j.smith@email.com"
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":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'

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

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

3. 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.
4. 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}.
5. 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:

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

1. 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.
2. 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.

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

1POST https://your.hostname/your_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"j.smith@email.com",
7  "password":"123456",
8  "username":"j.smith@email.com"
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":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'

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

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

3. 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.
4. O servidor Xsolla Login gerará um JWT de usuário.
5. 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.

1. 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.
2. 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.

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

1POST https://your.hostname/your_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"j.smith@email.com",
7  "password":"123456",
8  "username":"j.smith@email.com"
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":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'

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

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

3. 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.
4. O servidor Xsolla Login gerará um JWT de usuário.
5. 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.

1. O cliente abre um formulário de autenticação para que o usuário possa inserir seu número de telefone.
2. O usuário insere o número de telefone.
3. 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.
4. O cliente exibe um campo para que o usuário possa preencher o código de verificação.
5. O usuário insere o código de verificação recebido.

6. 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.
7. 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.
8. 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:

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:

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

1. O cliente abre um formulário de autenticação para que o usuário possa inserir seu número de telefone.
2. O usuário insere o número de telefone.
3. 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.
4. O cliente mostra um campo para o usuário preencher o código de confirmação.
5. O usuário insere o código de verificação recebido.

6. 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.
7. 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.
8. 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:

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:

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

1. O cliente abre um formulário de autenticação para que o usuário possa inserir seu endereço de e-mail.
2. O usuário insere o endereço de e-mail.
3. 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.
4. O cliente exibe um campo para que o usuário possa preencher o código de verificação.
5. O usuário insere o código de verificação recebido.

6. 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.
7. 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.
8. 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:

1POST https://your.hostname/your_email_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email": "user@mail.com",
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": "user@mail.com","type": "email"}'

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

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

1. O cliente abre um formulário de autenticação para que o usuário possa inserir seu endereço de e-mail.
2. O usuário insere o endereço de e-mail.
3. 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.
4. O cliente mostra um campo para o usuário preencher o código de confirmação.
5. O usuário insere o código de verificação recebido.

6. 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.
7. 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.
8. 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:

1POST https://your.hostname/your_email_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email": "user@mail.com",
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": "user@mail.com","type": "email"}'

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

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

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:

1. 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.
2. O usuário acessa uma rede social.
3. 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.

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:

Exemplo de uma carga útil de token:

 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": "example@test.com",
 9  "username": "Smith707",
10  "provider": "google",
11  "id": "123",
12}

Exemplo de webhook de URL de login social:

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:

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

4. 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 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:

1. 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.
2. O usuário acessa uma rede social.
3. 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.

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:

Exemplo de uma carga útil de token:

 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": "example@test.com",
 9  "username": "Smith707",
10  "provider": "google",
11  "id": "123",
12}

Exemplo de webhook de URL de login social:

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:

 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:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 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}

4. 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.