Iniciar autenticação por e-mail

post/oauth2/login/email/request

Inicia a autenticação pelo endereço de e-mail do usuário e envia um código de confirmação para o endereço de e-mail dele. A vida útil do código é de 3 minutos.

Essa chamada é usada somente com a chamada Complete auth by email.

O fluxo de trabalho no usar esta chamada:

O aplicativo 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 aplicativo envia esta solicitação ao servidor Xsolla Login: a. Se o parâmetro send_link for true, após essa solicitação, você deverá enviar a solicitação [Get confirmation code para que o e-mail contenha o código de confirmação e o link. b. Se o parâmetro send_link for false ou não passado, o e-mail conterá apenas o código de confirmação.
O servidor Xsolla Login envia o e-mail e retorna o ID do código de confirmação.
O aplicativo mostra um campo para que o usuário possa preencher o código de confirmação.
O usuário insere o código de confirmação recebido ou segue o link.
O aplicativo envia a solicitação Complete auth by email para o servidor Xsolla Login com o ID recebido.
O usuário é considerado autorizado.

Request

query Parameters

response_type required	string Tipo de concessão usado em seu projeto que possui o protocolo OAuth 2.0 habilitado. Deve ser `code` para obter o código de autenticação do usuário na resposta. O código recebido deve ser trocado para um JWT através da chamada Generate JWT para finalizar a autenticação do usuário.
client_id required	integer Seu ID de aplicativo. Obtenha-o depois de criar um cliente OAuth 2.0.
state required	string Valor usado para verificação adicional do usuário. Frequentemente usado para mitigar ataques CSRF. O valor será retornado na resposta. Deve ter mais de 8 símbolos.
scope	string O escopo é um mecanismo no OAuth 2.0 para limitar o acesso de um aplicativo à conta de um usuário. Pode ser: `offline` para usar `refresh_token` a partir da chamada Generate JWT para atualizar o JWT quando ele expirar. `playfab` para escrever SessionTicket para a reivindicação `session_ticket` do JWT se você armazenar os dados do usuário no PlayFab. Se você processar seus próprios valores do parâmetro `scope`, que não são mencionados acima, poderá defini-los ao usar essa chamada. O servidor Xsolla Login não processa esses valores, mas os retorna no JWT recebido.
redirect_uri	string URL para redirecionar o usuário após a confirmação da conta, autenticação bem-sucedida ou confirmação de redefinição de senha. Para configurar esse parâmetro, entre em contato com o Gerente de Sucesso do Cliente ou envie um e-mail para csm@xsolla.com. Aviso O parâmetro será necessário se você tiver mais de um URL de redirecionamento nas configurações do projeto.

Request Body schema: application/json

email required	string [ 1 .. 255 ] characters Endereço de e-mail do usuário.
link_url	string <uri> URL para redirecionar o usuário para a página de autenticação de status. Obrigatório se o parâmetro `send_link` for `true`.
send_link	boolean Mostra se um link é enviado com o código de confirmação no e-mail ou não. O link pode ser usado em vez do código de confirmação para fazer login. Se o parâmetro tiver o valor `true`, o link será enviado no e-mail.

Responses

200

400

Pedido incorreto

404

Não encontrado

422

Entidade não processável

429

Pedidos demais

Request samples

application/json

{"email": "string",
"link_url": "http://example.com",
"send_link": true
}

Response samples

application/json

{"operation_id": "string"
}