1.2 - Trocar senha

Índice

1 Índice
2 Orientações
3 Critérios de preenchimento
4 Objetos e atributos de retorno
5 Método de “trocarSenha”
- 5.1 Endpoint
- 5.2 Parâmetros de entrada
- 5.3 Exemplo request
- 5.4 Descrição dos objetos e atributos de retorno - Sucesso
  - 5.4.1 Exemplo retorno API - sucesso
  - 5.4.2 Exemplo retorno API - falha

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

Orientações

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.
Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

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-confirmacao
mensagem
mensagem

Método de “trocarSenha”

Endpoint

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

Endpoint	Método	Header Content-Type	Descrição
exemplo.com/trocarSenha	POST	application/json	Endpoint de trocar senha

Parâmetros de entrada

Atributo	Obrigatoriedade	Tipo	Descrição

Atributo	Obrigatoriedade	Tipo	Descrição
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	OP	Objeto	nó integração retornado no login

Exemplo request

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

Body:
{
  "novaSenha": "teste123",
  "senhaAtual":"mobi123",
  "chaveUnica":"10102",
  "integracao": {
    "xpto": "voluptatibus",
    "xyz": "quibusdam",
    "abcdef": 9288701
  }
}

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

Está indicado abaixo a estrutura de retorno do seu método login. 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!"
}

Exemplo retorno API - falha

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