Informações

Avisos

1. Só são suportadas integrações no padrão REST.
2. O campo "Regra de preenchimento" esclarece quais regras / validações serão aplicadas ou quais os conteúdos serão permitidos ou rejeitados. As ações descritas aqui devem ser implementadas por seus WS, evitando que os conteúdos inválidos sejam criticados pelo nosso sistema de integrações.

...

...

Parâmetros de entrada

...

Objeto beneficiario

Essa estrutura contém os dados básicos de um beneficiário de plano de saúde.

...

...

Retorno API - Falha

{
    "status": false,
    "motivoCritica": ""
}

Método de "lembrarSenha"

Este serviço é utilizado para recuperar os dados do usuário quando ele não se lembrar do usuário e senha de acesso.

Este método é único para beneficiário e profissional de saúde.

Regras de negocio

• O webservice deverá confrontar as informações fornecidas pelo usuário e só recuperar a senha caso a validação seja positiva e a regra de negócio da empresa permitir o acesso ao usuário;
• Quando alguma informação fornecida pelo usuário não for válida, retornar uma mensagem indicando claramente qual foi a informação que não confere, por exemplo:
• Se a data de nascimento não bater: A data de nascimento do usuário  não confere;
• O envio das informações será feito pelo servidor da Mobile Saúde, portanto, o webservice deverá retornar o login, a senha, o email  e / ou o telefone do usuário para que possamos enviar via mensageria;
• O webservice pode optar por recuperar a senha gravada no banco ou gerar uma nova senha aleatória entre 8 e 16 dígitos, contendo pelo menos uma letra, conforme regras da TISS;

Endpoint

...

...

...

exemplo.com/lembrarSenha

...

POST

...

Parâmetros de entrada

...

...

String

...

...

...

M

String

...

Request body

{
  "cpf": "<cpf>",
  "dataNascimento": "<dataNascimento>"
}

Objetos e atributos de retorno

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

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

Objeto principal

...

...

Indica que as informações fornecidas pelo usuário conferem e a recuperação de senha foi bem sucedida.

...

String

...

Retorna o usuário de acesso.

...

Retorna a senha de acesso.

...

...

Email do usuário.

O sistema da Mobile Saúde irá enviar os dados para este endereço de email.

...

String

...

Telefone do usuário.

Quando não tiver um email cadastrado, o sistema da Mobile Saúde pode enviar os dados de acesso por SMS, via mensageria.

...

Boolean

...

true/false

Se, durante o ato da recuperação de senha o seu webservice realizar o envio automático com os dados do usuário, retorne true neste campo. Isso fará com que a Mobile Saúde não envie nenhuma notificação neste momento. Caso contrário, informe false.

...

...

Caso queira enviar um alerta para o usuário, utilize esta propriedade.

Exemplo de uso: se o seu ws tenha enviado o e-mail, envie um alerta assim: Os dados de acesso foram enviados para o email xxxx@xxxx.com.br

...

Retorno da API - Sucesso

{
    "status": true,
    "login": "derlandy@mobilesaude.com.br",
    "senha": "mobi123",
    "email": "derlandy@mobilesaude.com.br",
    "telefone": "27999826284",
    "enviado": false,
    "alerta": null
}

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

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.

Objeto principal

Retorno API - Falha

{
    "status": false,
    "motivoCritica": ""
}

...

Este método é único para beneficiário e profissional de saúde.

Regras de negocio

• Enviaremos o usuário e a nova senha. O sistema altera a senha e retorna True caso tenha sucesso, ou False e o motivo da negativa caso não tenha sucesso na alteração da senha;
• A confirmação de senha será feita na própria interface de alteração de senha e não é necessária no webservice;
• Será adicionado ao corpo da requisição as informações enviadas no atributo integracao no retorno do login.
• Um ponto de atenção caso sua estrutura seja multi contrato, quando houver a troca de senha, que será realizada após o login do beneficiário na plataforma com o mesmo logado, as credenciais de acesso (login e senha) será para ambos contratos.
• Você pode ou não enviar no cabeçalho da requisição o auth gerado no endpoint de login é opcional e não obrigatório, isso garante que o beneficiário está autenticado no sistema.

Endpoint

Parâmetros de entrada

Request body

{
  "integracao": {
	"<chave>": "<valor>"
  }
  "login": "<login>"
  "senhaAtual": "<senhaAtual>",
  "novaSenha": "<novaSenha>"
}

Objetos e atributos de retorno

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

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

Objeto principal

Retorno da API - Sucesso

{
    "status": true
}

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

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

Objeto principal

Retorno API - Falha

{
    "status": false,
    "motivoCritica": ""
}

...

Em termos práticos, este webservice seria consumido por um link chamado “Crie seu acesso“ na tela de login.

Regras de negocio

• Este webservice deverá validar todas as regras de negocio da empresa e só permitir a criação do acesso do usuário caso ele seja um beneficiário ou profissional de saúde ativo e que tenha direito de uso. Este método é único para beneficiário e profissional de saúde.
• O webservice deverá retornar o usuário que fez login.
  • Quando o usuário for um titular.
  • Retorna os seus dados + dados dos dependentes.
  • Quando o usuário for o cônjuge.
  • Retorna os seus dados + os demais dependestes e exclui o titular do retorno.
  • Quando for outro tipo de dependente.
  • Retorna apenas os seus dados e de nenhum outro dependente ou titular.
  • O seu sistema deve identificar se o usuário também é um profissional de saúde e se sim, deve retornar a estrutura dedicada ao profissional de saúde.
• Regra sugerida para o perfil do Beneficiário.
• Regra sugerida para o perfil do Profissional de saúde.
• Quando o perfil for Empresa, não é necessário retornar nenhum beneficiário.
• Quando o perfil for exclusivamente profissional de saúde, não é necessário retornar a estrutura de beneficiário.
• Quando o perfil for exclusivamente beneficiário, não é necessário retornar a estrutura de profissional de saúde.
• Quando o perfil for beneficiário e profissional de saúde, retornar todas as estruturas descritas no layout.
• Caso o usuário possua mais de um contrato, esses devem ser descritos no item Contratos e o array de beneficiário e de profissional de saúde deve conter as informações de todos os contratos.  
• Ex.: Beneficiário possui um plano de saúde com um filho dependente e um plano odontológico sem dependentes. Os dois contratos precisam estar descritos no array Contratos e o array Familia vai conter 3 objetos (dois do plano de saúde e um do plano odontológico). Essa mesma lógica se aplica à estrutura do profissional de saúde.
• A ideia é que se a criação do usuário seja bem sucedida, o app já faça o login imediatamente.

Endpoint

...

Request body

{
  "login": "<login>",
  "dataNascimento": "<dataNascimento>",
  "senha": "<senha>”,
  “email”: “<email@email.com>"
}

Objetos e atributos de retorno

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

Referência: Método "login" > Descrição dos objetos e atributos de retorno - Sucesso

...

Referência: Método "login" > Retorno API - Sucesso

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

Referência: Método "login" > Descrição dos objetos e atributos de retorno - Falha

Retorno API - Falha

Referência: Método "login" > Retorno API - Falha

...

• Este webservice deverá validar todas as regras de negócio da empresa e só permitir a recuperação do acesso do usuário caso ele seja um beneficiário ou profissional de saúde ativo e que tenha direito de uso. Este método é único para beneficiário e profissional de saúde.
• A ideia é que só altere a senha do usuário caso os dados informados estejam iguais aos cadastrados na sua base.
• Caso o usuário nunca tenha acessado a área restrita, fica a critério da operadora decidir se já cria o acesso com a nova senha ou retorna uma mensagem de erro dizendo que o usuário não está cadastrado e que deve passar pela funcionalidade de "Criar seu acesso"  .
• Um ponto de atenção caso sua estrutura seja multi contrato, quando houver a reinicialização da senha, as credenciais de acesso (login e senha) será para ambos contratos.

Endpoint

...

Request body

{
  "login": "<login>",
  "dataNascimento": "<dataNascimento>",
  "senha": "<senha>”,
  “email”: “<email@email.com>"
}

Objetos e atributos de retorno

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

Objeto principal

Retorno da API - Sucesso

{
    "status": true
}

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

Objeto principal

Retorno API - Falha

{
    "status": false,
    "motivoCritica": "Dados inválidos, verifique os dados informados"
}

...

...