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
...
| Informações |
|---|
| icon | false |
|---|
| title | 1.1 ChangePassword |
|---|
|
| Expandir |
|---|
| Informações |
|---|
| icon | false |
|---|
| title | Configuração |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users/{userId ou Email}/changePassword | Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Configuração |
|---|
| Domínio: localhost
Porta: 8051 Url Utilizada: http://localhost:8051/api/framework/v1/users/mestre/changePassword |
| Informações |
|---|
| A ser enviado na requisição | Bloco de código |
|---|
| {
"lastPassword": "Totvs@123",
"newPassword": "Abc.456",
"confirmationPassword": "Abc.456"
} |
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Positivo Postman |
|---|
| Em caso de sucesso, será retornado o respondeCode = 200 e a resposta em branco. |
| Informações |
|---|
| icon | false |
|---|
| title | 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
...
| Informações |
|---|
| icon | false |
|---|
| title | 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) | Informações |
|---|
| 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 |
| Expandir |
|---|
| Informações |
|---|
| icon | false |
|---|
| title | Configuração |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/framework/v1/users//{userId ou Email}/recoveryPassword | Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Positivo Postman |
|---|
| Em caso de sucesso, será retornado o respondeCode = 200 e a resposta em branco. |
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Negativo |
|---|
| Em caso de inconsistência, será retornado o respondeCode = 404 400 e a na resposta informará qual é a inconsistência. |
|
|
|
1.3 - ChangePasswordWithToken
...
| Informações |
|---|
| icon | false |
|---|
| title | 1.3 ChangePasswordWithToken |
|---|
|
| Expandir |
|---|
| Informações |
|---|
| icon | false |
|---|
| title | Configuração |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{userId ou Email}/changePasswordWithToken | Informações |
|---|
| A ser enviado na requisição | Bloco de código |
|---|
| {
"lastPassword": "{TOKEN}",
"newPassword": "Abc.456",
"confirmationPassword": "Abc.456"
} |
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Positivo Postman |
|---|
| Em caso de sucesso, será retornado o respondeCode = 200 e a resposta em branco. |
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Negativo |
|---|
| Em caso de inconsistência, será retornado o respondeCode = 404 400 e a na resposta informará qual é a inconsistência. |
|
|
|
|
