https://login.xsolla.com/api
Esta seção descreve as chamadas de API para trabalhar com Login. Configure seu projeto Login na Conta de Distribuidor antes de enviar solicitações.
The full list of IP addresses that login.xsolla.com may use:
Você tem acesso aos seguintes tipos de projeto Login na Conta de Distribuidor:
Para obter mais informações sobre ele, consulte o recurso Conta multiplataforma.
São as restrições aplicadas pela API Xsolla sobre a frequência de acesso por um usuário dentro de um período de tempo definido.
É um tipo de conta criado em um projeto Login padrão e vinculado a contas de plataforma. A conta principal é usada para identificar o jogador em diferentes plataformas.
É um tipo de conta criado em um projeto de Login sombra e conectado a uma plataforma de distribuição definida. A conta da plataforma não pode ser vinculada a outra conta da plataforma. Além disso, não é possível desvincular as contas de uma conta principal.
É uma plataforma de jogos que é usada para a distribuição de jogos (por exemplo, Steam, PlayStation, Xbox, etc.).
A Login API oferece suporte aos seguintes tipos de token:
Você pode determinar se uma chamada de API ocorre no lado do cliente ou do servidor pelo esquema de autenticação:
Authorization
header: Bearer <user_JWT>
header,
where <user_JWT>
— is the user token.X-SERVER-AUTHORIZATION: <server_JWT>
, where
<server_JWT>
— is the server token.Para obter o token, envie uma das seguintes solicitações:
Após a autenticação JWT, o usuário é redirecionado para o URL de retorno de
chamada com um token em um parâmetro de consulta: <Callback URL>?token=<User token (JWT)>
.
Após a autenticação baseada no protocolo OAuth 2.0, envie a solicitação
Generate JWT
ao servidor do Xsolla Login para trocar o parâmetro code
recebido por um
token de usuário (access_token
).
Para obter um token de servidor:
No back-end do seu aplicativo, implemente um método para obter o JWT do servidor usando a chamada Generate JWT API. A solicitação deve conter os seguintes parâmetros:
grant_type
é o tipo de obtenção de JWT; passa o valor client_credentials
.client_secret
é a chave secreta que é recebida quando você configura o
cliente OAuth 2.0 do servidor.client_id
é o ID do cliente recebido quando você configura o cliente OAuth
2.0 do servidor.Para evitar sobrecarregar o sistema Xsolla e proteger contra picos repentinos
no tráfego de entrada, a Xsolla limita o número de solicitações recebidas pela
API Xsolla dentro de um período de tempo especificado. Se o limite for
excedido, a API Xsolla retornará uma resposta HTTP com o código de status
429
.
Rate limits vary by method, IP-address, authentication scheme, and other factors.
Rate limits for server-side methods are applied to methods with server-side
authentication — methods that are called with the X-SERVER-AUTHORIZATION:
<server_JWT>
header, where <server_JWT>
is the server
token.
Rate limits for client-side methods are applied to methods without
authentication or with client-side authentication — methods that are called
with the Authorization: Bearer <user_JWT>
header, where
<user_JWT>
is the user token.
Example of a method with server-side authentication: Example of a method with client-side authentication:
Os limites de taxa para métodos do lado do cliente não mudam e são necessários para evitar ataques de força bruta. A taxa máxima de solicitação para métodos do lado do servidor é maior do que para métodos do lado do cliente. Você pode consultar as recomendações sobre como gerenciar limites de taxa na documentação.
Cada token tem um formato JWT e contém uma informação definida em uma carga.
O JWT do usuário é um token recebido como resultado da autenticação ou cadastro. Uma carga de token contém informações sobre o usuário e a chamada de autenticação.
Para obter um token de usuário por meio do protocolo OAuth 2.0, você precisa de
um cliente OAuth 2.0. O token de usuário é passado no cabeçalho Authorization: Bearer <JWT>
.
Um token conterá as principais declarações após a autenticação ou confirmação do endereço de e-mail. A presença dessas declarações não depende do banco de dados do usuário e da chamada de autenticação.
Reivindicar | Tipo | Obrigatório | Descrição |
exp |
Carimbo de data/hora Unix | Sim | Data e hora da expiração do token. O tempo de expiração padrão é de 24 horas. Você pode alterar o tempo de expiração para cada projeto Login. |
iss |
cadeia de caracteres | Sim | Serviço que assinou o token: https://login.xsolla.com . |
iat |
Carimbo de data/hora Unix | Sim | Data e hora de entrega do token. |
sub |
cadeia de caracteres (UUID) | Sim | ID do usuário escrito no lado do servidor Xsolla Login. |
groups |
matriz | Sim |
A lista de grupos em que o usuário está. Cada grupo é escrito no seguinte formato:
Só pode haver um grupo padrão. Esse grupo inicialmente inclui todos os usuários antes que eles sejam distribuídos em grupos diferentes. |
xsolla_login_project_id |
cadeia de caracteres (UUID) | Sim | ID do projeto Login. |
type |
cadeia de caracteres |
Opção de autenticação:
Só pode haver um grupo padrão. Esse grupo inicialmente inclui todos os usuários antes que eles sejam distribuídos em grupos diferentes. |
|
avatar |
cadeia de caracteres | URL do avatar do usuário. | |
username |
cadeia de caracteres | Nome de usuário. | |
publisher_id |
número inteiro | ID de um comerciante que possui um projeto de login. | |
email |
cadeia de caracteres | Endereço de e-mail do usuário. | |
payload |
cadeia de caracteres | Informações adicionais que são passadas no parâmetro de carga durante a autenticação. | |
promo_email_agreement |
valor booleano |
Pode ter um dos seguintes valores:
true por padrão.
Para adicionar o recurso ao formulário de registro do Login widget:
|
|
connection_information |
cadeia de caracteres | Mostra se o usuário confirmou a data de nascimento ou não. A confirmação é feita através do serviço okname. |
Declarações contidas no token após a autenticação se você usar o armazenamento PlayFab.
Reivindicar | Tipo | Obrigatório | Descrição |
external_account_id |
cadeia de caracteres | Sim | ID do usuário PlayFab. |
session_ticket |
cadeia de caracteres | Sim |
Um parâmetro SessionTicket recebido durante uma solicitação de autenticação ou solicitações para a PlayFab API. Um token conterá a declaração se você autenticar usuários por meio do protocolo OAuth 2.0 e passar o valor |
entity_token |
cadeia de caracteres | Sim | Um parâmetro EntityToken.EntityToken. |
entity_type |
cadeia de caracteres | Sim | Um parâmetro EntityToken.Entity.Type. Só aceita o valor title_player_account . |
entity_id |
cadeia de caracteres | Sim | Um parâmetro EntityToken.Entity.Id. |
Declarações contidas no token após a autenticação se você usar armazenamento personalizado.
Reivindicar | Tipo | Obrigatório | Descrição |
provider |
cadeia de caracteres | Sim | Nome de uma rede social usada para autenticação. Se o usuário autenticar via nome de usuário e senha, a declaração terá o valor xsolla . |
external_account_id |
cadeia de caracteres | ID do usuário no lado do servidor. | |
partner_data |
Data of any type returned by your server in the response body during authentication. To enable the transmission of this claim, contact your Customer Success Manager or email to csm@xsolla.com | ||
social_access_token |
Access token of the social network through which the user was authenticated. To enable the transmission of this claim, contact your Customer Success Manager or email to csm@xsolla.com. |
Declarações contidas no token após a autenticação do OAuth 2.0.
Reivindicar | Tipo | Obrigatório | Descrição |
jti |
cadeia de caracteres | Sim | ID de token exclusivo. |
Reivindicação que está contida no token após a autenticação por meio de um número de telefone.
Reivindicar | Tipo | Obrigatório | Descrição |
phone_number |
cadeia de caracteres | Sim | Número de telefone do usuário usado para autenticação. O formato de número de telefone com base no código do país, código de área e número de linha sem divisórias. |
O token do servidor é passado no cabeçalho X-SERVER-AUTHORIZATION
.
A carga do token contém informações sobre recursos pertencentes ao cliente OAuth 2.0. O token tem acesso a chamadas com autenticação baseada em servidor para esses recursos.
Reivindicar | Tipo | Obrigatório | Descrição |
xsolla_login_project_id |
cadeia de caracteres (UUID) | Sim | ID de um projeto Login que possui o cliente OAuth 2.0. |
resources |
matriz | Sim |
Lista de recursos pertencentes a um cliente OAuth 2.0. Tipos possíveis de recursos:
Cada grupo é escrito no seguinte formato:
|
jti |
cadeia de caracteres | Sim | ID de token exclusivo. |
To validate the JWT, use the following Login API calls:
Aviso
Não revele sua chave secreta a ninguém. Se ela foi comprometida, atualize-a.
Em caso de respostas de erro, o servidor do Xsolla Login retorna um objeto JSON com os seguintes campos:
Campo | Tipo | Descrição |
código | cadeia de caracteres | Código de erro do servidor Xsolla Login. |
descrição | cadeia de caracteres | Descrição do erro. O texto está sempre em inglês. Não use este texto em caso de erro, pois o valor pode mudar no futuro. |
{
"error": {
"code": "000-000",
"description": "description"
}
}
---------------------------------------------------------------------------:| |
002-016 | accountID
parameter in the response body. | | 008-009 |
Policies and Agreements). | | 008-014 |
Okta integration not completed. | Contact the integration team through any messenger. | | 008-015 |SAML integration not completed. | Contact the integration team through any messenger. | | 008-016 |Firebase API key not set. | Add the API key to the settings in your Publisher Account (section Legal Terms > Policies and Agreements). | | 010-004 |Service temporarily unavailable. Try again later. | The user should try again later. | | 010-005 |Allowable number of requests exceeded. Try again later. | The user should try again later. | | 010-006 |If this social profile is unlinked, no authentication methods will be available. | The user should add another authentication method before unlinking the social network. | | 010-007 |Incorrect CAPTCHA input. Try again. | The user should complete the CAPTCHA again. | | 010-010 |Invalid confirmation code. | The user should verify the code and try again. | | 010-014 |Your code is expired. Return to the login page and log in again. | The user should log in again from the login page. | | 010-015 |Something went wrong during authentication with this social network. Try again later. | The user should try again later. | | 010-016 |This social account is already linked to another user. | The user should use a different social account. If they believe this is an error, they should contact the integration team through any messenger. | | 010-017 |Client authentication failed. Some request parameters are missing in request or have invalid values. | Verify the correctness of the request parameters being sent. | | 010-019 |Client authentication failed. Client with this client_id value does not exist. | Ensure that a client with the providedclient_id
exists. | | 010-020 |Client authentication failed. Parameter scope is invalid or malformed. | Ensure that the providedscope
parameter is correct. Refer to the instructions for detailed setup information. | | 010-021 |Client authentication failed. Parameter response_type is invalid or malformed. You should pass value of code parameter to response_type. | Ensure that the value of theresponse_type
parameter is set to"code"
. | | 010-022 |Client authentication failed. Parameter state is missing or its value has less than 8 characters. | Ensure that the state parameter is present and consists of at least 8 characters. | | 010-023 |Client authentication failed. Authorization code, authorization grant types, or refresh token are invalid or expired. Also this error is returned when the redirect_uri given in authorization grant type does not match the URI provided in access token request. | Ensure that the authorization code is valid and not expired, and that theredirect_uri
parameter contains an authorized URL. Refer to the instructions for detailed setup information. | | 010-026 |The resource owner or authorization server denied the request. | Ensure that you have sufficient permissions to access the resource. | | 010-030 |Cross social network is not enabled for this Login. | Ensure that cross-authentication is enabled for the authorization option. Refer to the instructions for detailed setup information. | | 010-031 |Social provider already exists. | The error occurs when attempting to connect a social network that is already enabled. | | 010-032 |Social network is not enabled for this Login. You can enable it in your Xsolla Publisher Account > Login Project > Social connections. | Ensure that the social network is enabled and configured in the authorization option settings in your Publisher Account (section Authorization via Social Networks). | | 010-033 |This call is temporary unavailable. | The user should try again later. | | 010-035 |Dependency service is unavailable | The user should try again later. | | 010-045 |Account with this social provider email address already exists. | The user should use a different social account for registration. | | 030-024 |Password recovery is not allowed. | The user should contact the game support team. | | 040-001 |Email address must be 254 characters or shorter. | The user should enter an email address containing no more than 254 characters. | | 040-002 |Username of the email address is invalid. Try another email address. | The user should enter a valid email address. | | 040-003 |Local part of the email address is too long. | The user should enter a different email address. | | 040-004 |Email address domain is invalid. Try another email address. | The user should contact Xsolla support. | | 040-005 |Email address should contain one @ character only. (E.g., username@example.com) | The user should enter an email with only one@
character. | | 040-006, 040-007, 040-008 |Email address domain is invalid. Try another email address. | The user should contact Xsolla support. | | 040-009 |Email address domain doesn’t exist. Try another email address. | The user should enter an email with an existing domain. | | 040-010 |Email address domain is not allowed. Try another email address. | The user should contact Xsolla support. | | 010-018 |Email address is invalid. Try another email address. | The user should enter a different email address. | | 300-003 |Allowable number of requests exceeded. Try again later. | The user should try again later. | | 300-005 |Failed to resend code. Try again later. | The user should try again later. | | 300-006 |Incorrect confirmation code. Check the code that you received and try again. | The user should verify and re- enter the confirmation code. | | 300-008 |You've exceeded the maximum number of attempts. Use the new code sent to your email or phone. | The user should use the new code sent to their email or phone. | | 003-007 |User account not confirmed. | The user should confirm their email address to activate the account. If they haven't received a confirmation email, they should check the spam folder. | | 003-025 |Error occurred while getting OAuth 2.0 access token. | The user should try a different authentication method. | | 003-040 |Unauthorized user. | The user should log in again. | | 003-033 |Mismatch project type. | Ensure that shadow authentication is used for the authorization option. | | 2002-0001 |Duplicated attributes. | Make sure that the attribute being created has not been previously added to the user. |