Linha RM

Atalhos

Páginas filhas
  • API de Recuperação e Alteração de senha

Sumário


Objetivo

      Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.

1 - Métodos

      Serão apresentados os métodos, implementados complementarmente na API de Usuários, são eles:

  • ChangePassword (POST)
  • RecoveryPassword (POST)
  • ChangePasswordWithToken (POST)

1.1 - ChangePassword

1.1 ChangePassword

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{userId ou Email}/changePassword

Exemplo de Configuração

Domínio: localhost
Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/users/mestre/changePassword

Payload

A ser enviado na requisição

{
    "lastPassword": "Totvs@123",
   "newPassword": "Abc.456",
    "confirmationPassword": "Abc.456"
}

Exemplo de Resultado Positivo Postman

Em caso de sucesso, será retornado o respondeCode = 200 e a resposta em branco.

Exemplo de Resultado Negativo

Em caso de inconsistência, será retornado o respondeCode = 404 e a na resposta informará qual é a inconsistência.

1.2 - RecoveryPassword

1.2 RecoveryPassword

Ao executar a requisição Post, será enviado um e-mail para o e-mail cadastrado referente ao usuário informado na URL. 

Este e-mail irá possuir um Token que é valido somente para o usuário informado e possui o tempo de vida de um dia. Este Token servirá para alterar a senha do usuário utilizando o serviço 1.3 (ChangePasswordWithToken)

Atenção

O Token é invalidado de imediato caso o usuário referente ao token consiga realizar acesso ao sistema.

O Token é valido de acordo com a forma que foi gerado. Caso o token tenha sido através do CODUSUARIO, ao utilizar o serviço "ChangePasswordWithToken" o mesmo deverá ser utilizado com o CODUSUARIO, caso o token tenha sido gerado através do E-MAIL, ao utilizar o serviço "ChangePasswordWithToken" o mesmo deverá ser utilizado com o e-mail

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users//{userId ou Email}/recoveryPassword

Exemplo de Configuração

Domínio: localhost
Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/users/mestre/recoveryPassword

Url Utilizada: http://localhost:8051/api/framework/v1/users/[email protected]/recoveryPassword

Exemplo de Resultado Positivo Postman

Em caso de sucesso, será retornado o respondeCode = 200 e a resposta em branco.

Exemplo de Resultado Negativo

Em caso de inconsistência, será retornado o respondeCode = 400 e a na resposta informará qual é a inconsistência.

1.3 - ChangePasswordWithToken

1.3 ChangePasswordWithToken

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{userId ou Email}/changePasswordWithToken

Exemplo de Configuração

Domínio: localhost
Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/users/mestre/changePasswordWithToken

Url Utilizada: http://localhost:8051/api/framework/v1/users/[email protected]/changePasswordWithToken

Payload

A ser enviado na requisição

{
    "lastPassword": "{TOKEN}",
    "newPassword": "Abc.456",
    "confirmationPassword": "Abc.456"
}

Exemplo de Resultado Positivo Postman

Em caso de sucesso, será retornado o respondeCode = 200 e a resposta em branco.

Exemplo de Resultado Negativo

Em caso de inconsistência, será retornado o respondeCode = 400 e a na resposta informará qual é a inconsistência.