1.3.2 - Criação de nova senha

Índice

1 Índice
2 Orientações
3 Critérios de preenchimento
4 Objetos e atributos de retorno
5 Método - Recuperar Senha Nova Senha

Só são suportadas integrações no padrão REST.

Orientações

Este método tem como objetivo a criação de uma nova senha por meio de um formulário.
Formulário dinâmico criado pelo Formbuilder. A aplicação fica responsável por encaminhar o formulário informado para o método. Os parâmetros de entrada devem ser devidamente informados no formulário de autenticação utilizado configurador de integração.

Critérios de preenchimento

Abreviação	Nome	Descrição

Abreviação	Nome	Descrição
M	Mandatório	O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado.
C	Condicional	O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.
OP	Opcional	Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array

Objetos e atributos de retorno

Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração.

Exemplo do atributo "mensagem":

mensagem-aplicativo
mensagem-aplicativo
message
mensagem

Método - Recuperar Senha Nova Senha

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
/recuperarSenhaNovaSenha	POST	application/json	Endpoint de identificação do cliente

Exemplo request

url:
https://www.operadoradesaude.com.br/mobilesaude/recuperarSenhaNovaSenha

boby:
{
    "chaveUnica": "10101020",
    "integracao": {
        "xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
    },
    "novaSenha": "teste123",
    "confirmacao": "teste123"
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
mensagem	M	String	mensagem para ser exibida para o cliente

Exemplo retorno API - sucesso

{
  "mensagem": "Senha alterada com sucesso!"
}

Descrição dos objetos e atributos de retorno - falha

Objetos e atributos de retorno

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
mensagem	M	String	mensagem para ser exibida para o cliente	texto livre

Exemplo retorno API - falha

{
  "mensagem": "Senha inválida."
}