Conteúdo

1. Visão Geral

2. Configuração

3. Como enviar código de acesso para o usuário

4. Como redefinir a senha

5. Como modificar template do e-mail
6. Como adicionar URL com código de acesso no e-mail

01. Visão geral

.......

....

.....

,,,,

02. Configuração

03. Como enviar código de acesso para o usuário

Para realizar o envio do código de acesso, utilize o serviço passwordReset existente no contexto totvs-login, seguindo as premissas: 

• O método de requisição é do tipo POST 
• Não possui autenticação na requisição.
• Deve ser enviado o parâmetro email, contendo o e-mail do usuário do produto, que está solicitando o código de acesso.
• O usuário relacionado ao e-mail:
  • Deve ser do tipo INTERNO.
  • O e-mail não pode estar associado a mais de um usuário válido.
  • Não pode estar bloqueado;
  • Não pode estar inativo;
  • Caso não atenda os requisitos acima será retornado erro.
    • Erros sem mensagens
      • Erro de sintaxe inválida. ao utilizar o serviço terá como retorno status 400 Bad Request.
      • Exemplo: o parâmetro email errado(emaill) ou sem valor.
    • Erros com mensagens, são retornadas no formato JSON;

      • 

  • Documentação da manutenção de usuário: Manutenção de Usuário (SEC000AA)
• Exemplo: 
  • http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>
  • 

Ao executar o serviço com sucesso, o usuário receberá um e-mail contendo o código de acesso para redefinição de senha. O código de acesso deve ser encaminhado para o serviço de redefinição de senha, para mais informações leia o conteúdo 04. Como redefinir a senha.

Abaixo temos o exemplo de um e-mail padrão contendo o código de acesso:

04. Como redefinir a senha

Para redefinir a senha, utilize o serviço passwordReset existente no contexto totvs-login, seguindo as premissas: 

• O método de requisição é do tipo POST 
• Não possui autenticação na requisição.
• A autorização para redefinição de senha será por meio do código de acesso.
• Deve ser enviado um JSON no corpo da requisição com as informações:
  • guid: É o código de acesso, que o usuário recebeu por e-mail;
  • newPassword: É a nova senha do usuário;
  • confirmNewPassword: É a confirmação da senha do usuário;
  • Exemplo:
    • 
• Caso não atenda os requisitos acima será retornado erro.
  • Erros sem mensagens
    • Erro de sintaxe inválida. ao utilizar o serviço terá como retorno status 400 Bad Request.
    • Exemplo: Corpo da requisição errada ou sem valor.
  • Erros com mensagens, são retornadas no formato JSON;
    • 
• Exemplo:
  • http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset
  • 

05. Como modificar o template do e-mail

A modificação do template do e-mail, ocorre por meio de uma chave referente a um template de e-mail parametrizado no produto, abaixo são apresentados os procedimentos: 

• O parâmetro keyTemplate, dever ser enviado no serviço responsável pelo envio do código de acesso. 
• Image Added
• Deve existir um template parametrizado no ambiente referente ao valor da keyTemplate
  • Caso não exista será utilizado o e-mail padrão. 
  Seguir os procedimentos apresentados no conteúdo: 03. Como enviar código de acesso para o usuário
• Exemplo com o parâmetro keyTemplate: 
  • http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>&keyTemplate=<CHAVE_DO_TEMPLATE>
  • Image Removed
• Exemplo de e-mail recebido:

• Image Modified

• Como retornar um Template de e-mail:
• Como retornar todos os Templates de e-mail:
• Como criar um Template de e-mail:
• Como atualizar um Template de e-mail:
• Como remover um Template de e-mail:

06. Como adicionar URL com o código de acesso no e-mail

dadsad

• Como retornar uma URL:
• Como retornar todas as URLs:
• Como criar uma URL:
• Como atualizar uma URL:
• Como remover um URL: