Cross Segmentos - Backoffice RM - Integração - API - Consumo API de Recuperação e Alteração de Senha – Central de Atendimento TOTVS

Tempo aproximado para leitura: 00:03:50 min

Dúvida
Como consumir a API de Recuperação e Alteração de Senha.

Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as versões.

Solução
Este documento tem o objetivo exemplificar o uso da API de Recuperação e Alteração de Senha, a fim de utilizar todos os métodos implementados.

1 - ChangePassword (POST)
2 - RecoveryPassword (POST)
3 - ChangePasswordWithToken (POST)

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/teste/changePassword

Payload

A ser enviado na requisição

{

    "lastPassword": "totvs",

   "newPassword": "totvs!123",

    "confirmationPassword": "totvs!123"
}

Exemplo de Resultado Positivo Postman

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

Exemplo de Resultado Negativo

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

Segue exemplo do Post do ChangePassword no Postman:

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 3 - ChangePasswordWithToken

Atenção

O Token é invalidado imediatamente caso o usuário consiga acessar o sistema.

O Token é válido conforme o método de geração. Se o token foi gerado usando o CODUSUARIO, ao utilizar o serviço "ChangePasswordWithToken", ele deverá ser utilizado com o CODUSUARIO. Se o token tiver sido gerado com o E-MAIL, então deve ser usado junto com o e-mail para o mesmo serviço.

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/teste01/recoveryPassword

Url Utilizada:http://localhost:8051/api/framework/v1/users/teste01@totvs.com/recoveryPassword

Exemplo de Resultado Positivo Postman

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

Exemplo de Resultado Negativo

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

Segue exemplo do Post do RecoveryPassword no Postman:

Ao finalizar a requisição com o status de sucesso, o e-mail será enviado com o token a ser utilizado no método 3 - ChangePasswordWithToken.

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/teste01/changePasswordWithToken

Url Utilizada: http://localhost:8051/api/framework/v1/users/teste01@totvs.com/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 responseCode = 200 e a resposta em branco.

Exemplo de Resultado Negativo

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

Segue exemplo do Post do ChangePasswordWithToken no Postman:

Saiba Mais:
Para mais informações sobre a API de Recuperação de Senha, acesse o link abaixo:
API de Recuperação e Alteração de senha

Olá,

Cross Segmentos - Backoffice RM - Integração - API - Consumo API de Recuperação e Alteração de Senha

0 Comentários

Olá ,

Olá ,

Olá ,

Olá,