Índice
Só são suportadas integrações no padrão REST.
Método “formPreLoadData”
Atente-se as orientações fornecidas pela Mobile Saúde;
Atente-se aos critérios de preenchimento;
Atente-se aos critérios de objetos e atributos de retorno;
Atente-se as mensagens de retorno para cada HTTPS Status Code;
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
exemplo.com/formPreLoadData | POST | application/json | Endpoint de formPreLoadData. Importante: o nome do método é sugerido, podendo ser configurado com outro nome caso necessário. |
Parâmetros de entrada
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 |
|---|---|---|---|---|
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!"
}