Iniciar autenticação por e-mail

Iniciar autenticação por e-mailClient-side

post/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

projectId required	string <uuid> ID do projeto Login da Conta de Distribuidor.
login_url	string URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. Required if there are several Callback URLs.
payload	string Seus dados personalizados. O valor do parâmetro será retornado na declaração `payload` do JWT do usuário. Recomenda-se um comprimento máximo inferior a 500 caracteres. Observe que esse parâmetro só estará disponível se você usar um armazenamento de dados de usuário personalizado.
with_logout	string Default: "0" Mostra se os valores JWT do usuário existentes devem ser desativados e ativa o valor gerado por essa chamada. Pode ter os seguintes valores: '1' para desativar os valores existentes e ativar um novo, '0' para manter os valores existentes ativados.

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"
}