/
1.1 - Login

1.1 - Login

Owned by Ranniêr Reis
Last updated: jan. 15, 2025 by Everson Delmaschio
26 min read

Índice

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

Orientações

Negócio

De acordo com a estrutura de sua empresa, o método de login pode devolver estruturas de login que permitam o acesso a alguns perfis de usuário:

  • Login de beneficiário;

  • Login de profissional de saúde;

  • Login de beneficiário + profissional de saúde (quando um profissional de saúde também é um beneficiário de plano de saúde);

 

Estrutura sugerida para o retorno do perfil do Beneficiário

  • Retorna os seus dados + dados dos dependentes;

  • Retorna os seus dados + os demais dependentes (não retorna os dados do titular);

  • Retorna apenas os dados do beneficiário logado;

  • Quando o usuário for um titular;

  • Quando o usuário for o cônjuge;

  • Quando for outro tipo de dependente (filho, filha, etc);

  • Dica: retorne apenas dados que possam ser exibidos. Se um beneficiário da família estiver, por exemplo,  bloqueado ou impedido de utilizar o plano, não devolva-o no retorno do endpoint.

 

Perfil do profissional de saúde

Caso seu sistema identifique que o usuário logado também é um profissional de saúde, o método deve retornar a estrutura dedicada aos profissionais de saúde;

 

Recomendações gerais

  • O endpoint de login deve validar todas as suas regras de negócio, permitindo acesso apenas a usuários autorizados;

  • O endpoint deverá retornar o usuário que fez login, e de acordo com o perfil, poderá enviar ainda mais informações;

  • 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 autenticado 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 Família 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;

Retornar ao índice

 

Segurança e permissões

Tokens de segurança ou autenticação

A Mobile Saúde descreve nesta documentação o formato de adoção obrigatória quando sua empresa desejar utilizar TOKENS de segurança.

O formato suportado pela aplicação está descrito no objeto SEGURANÇA, e sua empresa deve necessariamente implementa-lo conforme descrito quando desejar utilizar essa camada adicional de segurança.

Não serão suportadas outras formas de transacionar TOKENs de segurança, como por exemplo tokens de autenticação na URL da requisição, entre outros.

Caso tenha dúvidas, ou deseje maiores esclarecimentos, entre em contato com o gestor de projeto encarregado de sua implantação, para atendimento às questões ANTES DE DESENVOLVER SUA API.

 

Objeto permissões

Devemos somente informar na estrutura de permissões dentro do objeto contratos as funcionalidades que o usuário não tem acesso ou ocultar caso queira que não apareça, mas para requisito de validação da estrutura do beneficiário, eleger uma ou mais funcionalidades junto com a equipe de desenvolvimento da Mobile Saúde para facilitar os testes de permissionamento.

Clique aqui para visualizar a tabela de funcionalidades.

 

Exemplos de uso:

  • Funcionalidade negada com mensagem customizada

 "permissoes": [ {

        "funcionalidade": "1",

        "acesso": false,

        "mensagemBloqueio": "Você não possui acesso a está funcionalidade, para mais informações entre em contato com 0800",

        "ocultar": false

}]

  • Funcionalidade negada sem mensagem customizada, será exibida uma mensagem padrão

 "permissoes": [ {

        "funcionalidade": "1",

        "acesso": false,

        "mensagemBloqueio": null,

        "ocultar": false

}]

  • Funcionalidade oculta no app

"permissoes": [ {

        "funcionalidade": "1",

        "acesso": false,

        "mensagemBloqueio": null,

        "ocultar": true

}]

  • Acesso liberado

"permissoes": null

Retornar ao índice

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

Retornar ao índice

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 "usuarioLogado":

  • usuario-logado

  • usuario_logado

  • usuario

  • usuarioLogado

 

Grupo Familiar

Grupo Familiar
Grupo familiar são beneficiários (titulares, dependentes e agregados) que compõe uma familia o campo que determina esta amarração é o "cod_familia” ou seja todos que necessitam estar no mesmo grupo familiar necessitam estar com este código igual.

Visibilidade x Correlação

  • Titular: tipoUsuario = T e grauParentesco = 01

    • Retorna todos dentro do grupo familiar;

  • Dependente do tipo cônjuge: tipoUsuario = D e grauParentesco = 02

    • Retorna ele mesmo e todos os demais dependentes, excluindo os do tipo Agregado (A);

  • Dependentes diferentes do tipo cônjuge: tipoUsuario = D e grauParentesco != 02

    • Retorna apenas ele mesmo;

  • Agregados: tipoUsuario = A e grauParentesco > 02

    • Retorna apenas ele mesmo;

 

Multi-contrato

Multi-contrato

Em Operadoras de saúde é normal existir o mesmo beneficiário vinculado a contratos diferentes ou seja termos um beneficiário como:

Titular em um contrato e dependente em outro contrato.

Para que ele possa ter acesso a ambos os contratos o vinculo é realizado pelo campo chave_unica, ou seja um beneficiário em 2 contratos distintos é vinculado a partir deste campo os critérios de exibição seguem os conceitos de grupo familiar desta documentação.

Método de login

Endpoint

Endpoint

Método

Header Content-Type

Descrição

Endpoint

Método

Header Content-Type

Descrição

exemplo.com/login

Atenção

O endpoint obrigatoriamente deve terminar com "/login".

POST

application/json

Endpoint de login

 

Parâmetros de entrada

Parâmetro

Obrigatório

Tipo

Descrição

Parâmetro

Obrigatório

Tipo

Descrição

login

M

String

ID de identificação do usuário do app. Sugerimos que o login seja o CPF do usuário.

senha

M

String

Senha de acesso informada pelo usuário no momento do login.
Observação sobre criptografia: caso seja necessário criptografar a senha, sugerimos fornecer um acesso via HTTPS ao invés de usar algoritmos próprios.

 

Exemplo request

url: https://www.operadoradesaude.com.br/mobilesaude/login Body: { "login": "<login>", "senha": "<senha>" }

 

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

seguranca

OP

Objeto seguranca

Lista parâmetros que devem ser enviados no header dos demais endpoints de integração do sistema para garantir que o beneficiário está autenticado no sistema.

Preencher com o objeto do tipo "seguranca". Se não for utilizar não informar, ou informar com o valor "NULL"

usuarioLogado

M

Objeto usuarioLogado

Usuário que efetuou login

Objeto precisa ter sua estrutura completamente preenchida.

beneficiarios

C

Array de objetos "beneficiarios"

Array que contém todos os beneficiários vinculados ao login

Se contrato possuir tipo = "beneficiario", obrigatório ter a menos 1 registro com conteúdo válido. Caso contrário, não enviar o atributo ou preencher com o valor NULL

profissionaisSaude

C

Array de objetos "profissionalSaude"

Array que contém todos os profissionais de saúde vinculados ao login.



Se contrato possuir tipo = "profissionalSaude", obrigatório ter a menos 1 registro com conteúdo válido. Caso contrário, não enviar o atributo ou preencher com o valor NULL

contratos

M

Array de objetos "contrato"

Indique ao menos um contrato que está vinculado ao login.

Deve-se ter no mínimo 1 ocorrência válida, que tenha relação com um elemento do array "beneficiario" ou "profissionalSaude"

segmentacao

OP

Array de objetos "segmentacao”

 

 

mosia

OP

Objeto "mosia"

Identifique os atributos que permitem ao usuário do aplicativo ser corretamente encaminhado para o atendente do MOSIA.

Preencher quando possuir o produto Mosia. Caso não tenha o produto contratado, não enviar o atributo ou preencher com o valor NULL

agenteRelacionamento

OP

Array de objetos "agenteRelacionamento"

Indique os dados de atendentes que estarão disponíveis para serem visualizados como "contatos de atentes de atendimento". 

Preencher o array com objetos do tipo "agenteRelacionamento". Se não tiver nenhum contato desse tipo, não enviar o atributo ou preencher com o valor NULL

 

Objeto “seguranca”

Atributo

Critério

Tipo 

Descrição 

Regra de preenchimento

Atributo

Critério

Tipo 

Descrição 

Regra de preenchimento

auth

M

Array de objetos “auth”

Lista parâmetros que devem ser enviados no header dos demais endpoints de integração do sistema para garantir que o beneficiário está autenticado no sistema.

Objeto auth valido

 

Objeto “auth” 

  • Array de objetos “auth” que está contido no objeto “seguranca”;

{ "seguranca": { "auth": [Array-objetos] }

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chave

M

String

Nome do parâmetro no header aonde será enviado o valor da propriedade token.

 ASCII (nao permite especiais)

token

M

String

Valor do token que será enviado no header, em caso de tokens no padrão Bearer, JWT, Api-Key etc. enviar o prefixo junto do token. Ex: JWT 123xyz

Formato: Texto livre

expiracao

O

Number

Caso o token tenha data de expiração, deve ser retornado nessa propriedade o timestamp da data na qual o token irá expirar.

Timestamp (em milissegundos)

Retornar ao índice

 

Objeto “usuarioLogado”

"usuarioLogado": { "permissoes": [Array-objetos], "login": "string", "chaveUnica": "string", "contato": {objeto}, "esquemaCor": "String", "integracao": {objeto} },

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

login

M

String

A mesma informação digitada pelo usuário

 

ASCII (nao permite especiais - sem acentos, por exemplo)

chaveUnica

M

String

 Chave de identificação única de pessoa. Não deve se repetir em nenhuma hipótese, para pessoas diferentes.

Importante: caso um mesmo beneficiário esteja presente em mais de um contrato ou em mais de um grupo familiar, a chave única poderá se repetir, desde que seja o MESMO BENEFICIARIO.

É obrigatório o preenchimento deste campo:

Recomendamos o uso do CPF, pois é ÚNICO POR PESSOA, ou seja, 2 pessoas diferentes terão sempre CPFs diferentes. Porém, se a mesma pessoa tiver 2 ou mais planos, ela terá o mesmo CPF nos 2 planos, que é o desejado para este campo.

 

integracao

M

Objeto

Informações necessárias para realizar a identificação do beneficiário no sistema. Deve existir um objeto idêntico para um dos beneficiários no array "beneficiarios" para que seja feita a identificação de qual usuário está logado.

Não possui regra de preenchimento, pode ser enviada qualquer estrutura desde que seja uma estrutura JSON valida

contato

M

Objeto "contato”

 

 

esquemaCor

OP

String

O aplicativo pode ter uma customização de cores diferente do padrão, caso deseja que um usuário tenha essa customização, bastar criar um esquema de cor no configurador de aplicação definindo um nome para o esquema e cadastrando novas cores. Informe nesse campo o nome do apelido que foi gerado ao criar um novo esquema de cor.

Ex: Ao criar um esquema de cor e definindo um nome de "Esquema Premium", o apelido gerado será "esquema-premium". Informe esse apelido nesse campo.

A string deve ser a mesma que o apelido gerado na opção de esquema de cor no configurador de aplicação, caso tenha definido um esquema de cor que não existe, o aplicativo irá usar as cores padrão.

permissoes

OP

Array de objeto "permissoes"

 

Objetos válidos relacionados às funções do app contratado.

 

Objeto “contato”

  • Objeto “contato” que está contido no objeto “usuarioLogado”;

  • Essa estrutura contém os dados pra contato do usuário logado.

"usuarioLogado": { "contato": { "email": "string", "telefoneCelular": "string", "telefoneFixo": "string" } }

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

email

OP

String

Indique o email do usuario logado

Email precisa ser válido 

telefoneCelular

OP

String

Indique o telefone celular do usuário logado

 

Tamanho mínimo / máximo 11 posições. Somente números

telefoneFixo

OP

String

Indique o telefone fixo do usuário logado

Tamanho mínimo 10 / máximo 11 posições. Somente números

 

Objeto “integracao”

  • Objeto “integracao” que está contido no objeto “usuarioLogado”;

  • Não possui regra de preenchimento;

  • Pode ser enviada qualquer estrutura desde que seja uma estrutura JSON valida

"usuarioLogado": { "integracao": { "xpto": "voluptatibus", "xyz": "quibusdam", "abcdef": 9288701 } }

 

Objeto “permissoes”

  • Objeto “permissoes” que está contido no objeto “usuarioLogado”;

  • Essa estrutura contém as instruções sobre quais funcionalidades do aplicativo o usuário logado poderá visualizar ou ter acesso, conforme as regras de negocio da operadora.

  • Por padrão, todas as funcionalidades (do escopo do projeto) são permitidas e essa estrutura deve tratar a exceção, ou seja, apenas aquilo que o usuário não pode visualizar ou acessar.

"usuarioLogado": { "permissoes": [ { "funcionalidade": "string", "acesso": boolean, "mensagemBloqueio": "string", "ocultar": boolean } ] }

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

funcionalidade

M

String

Informe o ID da funcionalidade do App. A tabela de Ids de funcionalidade encontra-se no final desta documentação

Funcionalidade deve ter correlação com a tabela no fim desta  documentação

acesso

M

Boolean

Preencher com a chave relacionada aos atributos de "codigoContrato" dos objetos beneficiario e profissionalSaude

 

true/false

mensagemBloqueio

C

String

Preencha com beneficiario ou profissionalSaude

Só pode ter conteúdo quando acesso = false

ocultar

M

Boolean

informe se o ícone da funcionalidade será exibido (false) ou ocultado (true) para este contrato. 

true/false

 

Retornar ao índice

 

Objeto “beneficiarios”

"beneficiarios": [ { "chaveUnica": "string", "integracao": {objeto}, "dadosPessoais": {objeto}, "dadosDoContrato": {objeto}, "dadosDoPlano": {objeto}, "cartao": {objeto}, "bloqueio": {objeto}, "custom": {objeto} } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chaveUnica

M

String

Chave de identificação única de pessoa. Não deve se repetir em nenhuma hipótese, para pessoas diferentes.

Importante: caso um mesmo beneficiário esteja presente em mais de um contrato ou em mais de um grupo familiar, a chave única poderá se repetir, desde que seja o MESMO BENEFICIARIO.

É obrigatório o preenchimento deste campo:

Recomendamos o uso do CPF, pois é ÚNICO POR PESSOA, ou seja, 2 pessoas diferentes terão sempre CPFs diferentes. Porém, se a mesma pessoa tiver 2 ou mais planos, ela terá o mesmo CPF nos 2 planos, que é o desejado para este campo.

 

integracao

M

Objeto

Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema.

Não possui regra de preenchimento, pode ser enviada qualquer estrutura desde que seja um Objeto JSON válido.

dadosPessoais

M

Objeto "dadosPessoais"

 

 

 

dadosDoContrato

M

Objeto "dadosDoContrato"

 

 

dadosDoPlano

M

Objeto "dadosDoPlano"

 

 

cartao

M

Objeto "cartao"

 

 

bloqueio

OP

Objeto "bloqueio"

 

 

custom

OP

Objeto "custom"

 

 

 

Objeto “dadosPessoais”

  • Objeto “dadosPessoais” que está contido no objeto “beneficiarios”;

  • Essa estrutura contém os dados pessoais do beneficiário.

"beneficiarios": [ { "dadosPessoais": { "nome": "string", "dataNascimento": "string", "cpf": "string", "sexo": {objeto}, "contato": {objeto}, "estadoCivil": {objeto} } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

nome

M

String

Nome do beneficiário

Não permitir números, nem caracteres especiais. Permitido acentos

sexo

M

Objeto

objeto com codigo e descricao do sexo do beneficiário

 

dataNascimento

M

String

Data de nascimento do beneficiário

Formato: YYYY-MM-DD

contato

M

Objeto contato

 

 

cpf

OP

String

CPF do beneficiário

Somente números. Tamanho mínimo / máximo 11 posições.

estadoCivil

M

Objeto

 

 

nomeMae

OP

String

Nome da mãe do beneficiário

Nome da mãe do beneficiário, será muito bem utilizado em casos que necessitem de elegibilidade, redefinição de senha e etc.

 

Objeto “sexo”

  • Objeto “sexo” que está contido no objeto “dadosPessoais”;

"beneficiarios": [ { "dadosPessoais": { "sexo": { "codigo": "string", "descricao": "string" } } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

M = masculino, F = feminino, N = Não se aplica

descricao

 

String

 

“Masculino” , “Feminino” ou “Não se aplica”

 

Objeto “contato”

  • Objeto “contato” que está contido no objeto “dadosPessoais”;

"beneficiarios": [ { "dadosPessoais": { "contato": { "email": "string", "telefoneCelular": "string", "telefoneFixo": "string" } } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

email

OP

String

Indique o email do usuario logado

Email precisa ser válido 

telefoneCelular

OP

String

Indique o telefone celular do usuário logado

 

Tamanho mínimo / máximo 11 posições. Somente números

telefoneFixo

OP

String

Indique o telefone fixo do usuário logado

Tamanho mínimo 10 / máximo 11 posições. Somente números

 

Objeto “estadoCivil”

  • Objeto “estadoCivil” que está contido no objeto “dadosPessoais”;

"beneficiarios": [ { "dadosPessoais": { "estadoCivil": { "codigo": "string", "descricao": "string" } } } ]

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

C = casado, S = solteiro, V = viúvo, D = divorciado

descricao

 

String

 

“Casado”, “Solteiro”, “Viúvo”, “Divorciado”

 

Objeto “dadosDoContrato”

  • Objeto “dadosDoContrato” que está contido no array de objetos “beneficiarios”;

  • Essa estrutura contém os dados do contrato do beneficiário.

"beneficiarios": [ { "dadosDoContrato": { "numeroContrato": "string" } } ]

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

numeroContrato

M

String

 

 

 

Objeto “dadosDoPlano”

  • Objeto “dadosDoPlano” que está contido no array de objetos “beneficiarios”;

  • Essa estrutura contém os dados do plano do beneficiário.

"beneficiarios": [ { "dadosDoPlano": { "beneficiario": boolean, "idPlano": "string", "descricao": "string", "registroAns": "string", "segmentacao": "string", "acomodacao": "string", "tipoContratacao": "string", "regulamentacao": "string", "abrangencia": "string", "modalidadeCobranca": "string", "padraoConforto": "string", "participativo": boolean, "dataInicioVigenciaPlano": "string", "dataFinalCpt": "string", "dataInclusao": "string", "matricula": "string", "matriculaAntiga": "string", "matriculaFuncionario": "string", "tipoUsuario": {objeto}, "grauParentesco": {objeto}, "redeAtendimento": {objeto}, "carencias": [array-objetos] } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

beneficiario

M

Boolean

Indica se o objeto em questão trata de um beneficiário.

TRUE quando for beneficiário. FALSE quando não for beneficiário

idPlano

M

String

 

Formato: Texto livre

descricao

M

String

 

Formato: Texto livre

registroAns

M

String

Número de registro do plano do beneficiário na ANS. 

Formato: Texto livre

segmentacao

M

String

Texto descritivo da segmentação do plano do (produto). Exemplo de segmentação: Ambulatorial + Hospitalar com Obstetrícia. Sugere-se utilizar as segmentações definidas pela ANS, conforme registro de produtos.

Formato: Texto livre.

acomodacao

M

String

Texto descritivo do padrão de acomodação do plano do beneficiário, conforme ANS

Formato: Texto livre.

tipoContratacao

M

String

Informação sobre o tipo de contratação do plano privado de assistência à saúde, conforme RN 195. Individual/Familiar, coletivo por adesão ou coletivo empresarial.

Formato: Texto livre.

regulamentacao

M

String

Informação sobre a regulamentação do plano, entendendo-se por: Regulamentado / adaptado / não regulado.

Formato: Texto livre.

abrangencia

M

String

 

Formato: Texto livre.

modalidadeCobranca

M

String

Texto descritivo da modalidade de cobrança do contrato do beneficiário, como por exemplo: Pré-pagamento, Pós-pagamento e etc.

Formato: Texto livre.

padraoConforto

OP

String

Texto descritivo do padrão de conforto do plano (produto)

Formato: Texto livre.

participativo

OP

Boolean

Campo para informar se o plano (produto) do beneficiário possui coparticipação ou não.

True/False

dataInicioVigenciaPlano

M

String

Campo destinado para a data que o beneficiário iniciou no plano

Formato: YYYY-MM-DD

dataFinalCpt

OP

String

Data final da CPT do cliente, quando houver, no formato String.

Pode-se informar também textos indicativos, de acordo com a necessidade da operadora.

Obrigatório no cartão do beneficiário conforme RN 389.

Formato: Texto livre.

dataInclusao

OP

String

Data de inclusão do beneficiário no plano.

Formato: YYYY-MM-DD
Ex: 1990-08-05

matricula

M

String

Matrícula do beneficiário. Informar a matrícula completa, sem espaços ou caracteres especiais

 

ASCII (nao permite especiais - sem acentos, por exemplo). Será impressa no cartão

matriculaAntiga

OP

String

Matrícula do beneficiário no sistema antigo. Em alguns casos o cliente continua utilizando a matrícula do sistema antigo mesmo após trocar de sistema de gestão, para manter funcionando integrações com outros sistemas legados. Por este motivo é importante termos essa informação.

ASCII (nao permite especiais - sem acentos, por exemplo)

matriculaFuncionario

OP

String

Indicar o código da matrícula de funcionário na empresa patrocinadora, caso aplicável.

ASCII (nao permite especiais - sem acentos, por exemplo)

tipoUsuario

M

Objeto

 

 

grauParentesco

M

Objeto

Código do grau de parentesco do beneficiário em relação ao titular

Indicar o ID do grau de parentesco.

redeAtendimento

OP

Objeto

 

 

carencias

OP

Array de objeto "carencia"

Retorna uma lista de estruturas “carencia” contendo as instruções sobre as carências do usuário. Essa informação só é necessária se houver necessidade de apresentar as carências no cartão virtual.

Caso não exista nenhuma carência, envie o array vazio

'

Objeto “grauParentesco”

  • Objeto “grauParentesco” que está contido no objeto “dadosDoPlano”;

"beneficiarios": [ { "dadosDoPlano": { "grauParentesco": { "codigo": "string", "descricao": "string" } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

Código do grau de parentesco do beneficiário em relação ao titular. Indicar o ID do grau de parentesco.

descricao

 

String

 

descrição do grau de parentesco

 

Objeto “tipoUsuario”

  • Objeto “tipoUsuario” que está contido no objeto “dadosDoPlano”;

"beneficiarios": [ { "dadosDoPlano": { "tipoUsuario": { "codigo": "string", "descricao": "string" } } ]

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

Conteúdo válido:
T = Titular
D = Denpendente
A = Agregado
Apenas maiúsculos.

Importante. Só pode existir um (1) usuário no Array de beneficiários com a propriedate idTipoUsuario = T por contrato

descricao

 

String

 

Descrição do código: Titular, Denpendente, Agregado.

 

Objeto redeAtendimento

  • Objeto “redeAtendimento” que está contido no objeto “dadosDoPlano”;

"beneficiarios": [ { "dadosDoPlano": { "redeAtendimento": { "codigo": "string", "descricao": "string" } } ]

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

String

Código da rede de atendimento

Formato: Texto livre.

descricao

M

String

Descrição da rede de atendimento

Formato: Texto livre.

 

Objeto carencias

  • Objeto “carencias” que está contido no objeto “dadosDoPlano”;

  • Esta estrutura contém as informações sobre as carências do beneficiãrio para serem impressas no cartão virtual.

  • As informações enviadas nesta estrutura já devem estar prontas para serem aprestandas apara o beneficiário.

"beneficiarios": [ { "dadosDoPlano": { "carencias": [ { "tipoServico": "string", "carencia": "string" } ] } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

tipoServico

M

String

Texto com o tipo de serviço, exemplo: Consulta, Exames, Internação, Parto...

Formato: Texto livre.

carencia

M

String

 Informar o texto a ser apresentado. O campo tem conteúdo aberto, podendo exibir datas ou texto livre.

Exemplos: 

Vencida

31/12/2015

12 meses

Formato: Texto livre.

 

Objeto cartao

  • Objeto “cartao” que está contido no array de objetos “beneficiarios”;

  • Essa estrutura contém os dados do cartão do beneficiário.

"beneficiarios": [ { "cartao": { "modeloCartao": "string", "numeroCartao": "string", "validade": "string", "via": number, "numeroCns": "string", "apresentaCartaoVirtual": boolean, "nomeCartao":"string", "nomeSocialCartao":"string", "operadoraContratada":"string", "convenioAnsContratada":"string", "seed":"string", "convenioAbrangenciaVerso":"string" } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

modeloCartao

M

String

Indique o layout de cartão que deve ser exibido. O dado aqui deve ser idêntico ao acordado entre sua empresa e a Mobile Saúde, na documentação de layouts de cartões

ASCII (nao permite especiais). Torna-se obrigatório quando o cartão virtual foi contratado.
Obrigatório em minúsculo (lowercase)

numeroCartao

M

String

 

 

validade

M

String

Informe a data de validade do cartão

Formato: YYYY-MM-DD

via

M

Number

Indica o numero da via do cartão vigente do beneficiário

Somente números inteiros

numeroCns

M

String

Numero do Cartão Nacional de Saúde. 

Obrigatório no cartão do beneficiário conforme RN 389.

Formato: Texto livre.

Importante: caso não possua a informação, preencher com “NÃO CONSTA”.

apresentaCartaoVirtual

M

Boolean

 

True/False

nomeCartao

OP

String

Nome do beneficiário a ser exibido no cartão

Utilize esse campo para exibir um nome reduzido. Caso não seja informado, o nome do beneficiário será exibido no cartão com base no atributo "nome", dentro do objeto dados pessoais. 

nomeSocialCartao

OP

String

Nome social do beneficiário a ser exibido no cartão

Utilize esse campo para exibir um nome social reduzido. Caso não seja informado, o nome do beneficiário será exibido no cartão com base no atributo "nome", dentro do objeto dados pessoais.

operadoraContratada

OP

String

Informe a operadora contratada.

Formato: Texto livre.

convenioAnsContratada

OP

String

Informe o número de registro ANS da operadora contratada.

Formato: Texto livre.

seed

OP

String

Seed utilizado para gerar o token.

Formato: Texto livre, mas deve ser enviado como BASE32.

IMPORTANTE: A Mobile Saúde recomenda que o conteúdo deste campo SEED seja a matrícula do beneficiário.

Caso sua empresa não utilize o conceito de TOKEN para autorização, não preencha esse atributo.

convenioAbrangenciaVerso

OP

String

Texto descritivo da abrangência contido no verso do cartão

Formato: Texto livre.

compartilhamentoRisco

OP

Objeto

Objeto do tipo “compartilhamento de risco"

 

 

Objeto compartilhamentoRisco

  • Objeto “compartilhamentoRisco” que está contido no objeto “cartao" que está contido no array de objetos “beneficiarios” ;

  • Essa estrutura contém os dados de compartilhamento de risco.

"beneficiarios": [ { "cartao": { "compartilhamentoRisco": { "riscoAtivo": boolean, "operadoraOrigem": "string", "convenioAnsOrigem": "string", } } } ]

 

Objeto bloqueio

  • Objeto “bloqueio” que está contido no array de objetos “beneficiarios”;

  • Essa estrutura contém os dados do cartão do beneficiário.

"beneficiarios": [ { "bloqueio": { "bloqueado": boolean, "dataBloqueio": "string", "motivo": "string" } } ]

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

bloqueado

M

Boolean

 

True/False

dataBloqueio

C

String

 

Obrigatório quando bloqueado = true.
Formato: YYYY-MM-DD

motivo

C

String

 

Obrigatório quando bloqueado = true.
Formato: Texto livre.

 

Objeto custom

  • Objeto “custom” que está contido no array de objetos “beneficiarios”;

  • Utilize esse objeto para enviar campos que não são suportados pelo layout padrão de atributos (por exemplo, exibir número da matricula funcional de empregado, tipo sanguíneo e etc).

  • Crie quantas chave / valor forem necessários, desde que obedeçam as premissas descritas no objeto.

"beneficiarios": [ { "custom": { "chave": "valor", "chave2": "valor2", "chave3": "valor3" } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chave

M

String

Nome da propriedade

Formato: Texto livre. Importante: SEMPRE ENVIAR COMO STRING

valor

M

String

Valor da propriedade

Formato: Texto livre. IMPORTANTE: SEMPRE ENVIAR COMO STRING, MESMO QUE O CONTEÚDO SEJA NUMÉRICO, DATA, OU OUTRO FORMATO.

 

Retornar ao índice

 

Objeto “profissionaisSaude”

"profissionaisSaude": [ { "nome": "string", "chaveProfissionalSaude": "string", "conselhoRegional": "string", "siglaConselhoRegional": "string", "estadoConselhoRegional": "string", "titulo": "string", "sexo": "string", "dataNascimento": "string", "cpf": "string", "celular": "string", "especialidades": [array-objetos], "codigoContrato": "string", "email": "string" } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

nome

M

String

Nome do contrato

Não permite números 

chaveProfissionalSaude

M

String

Chave única de identificação do profissional de saúde no seu sistema de gestão. Este campo será utilizado pelo aplicativo como chave em todas as demais integrações referentes ao perfil de profissional de saúde, como por exemplo: extrato de pagamento, declarações e solicitações. Ele deve ser único por coooperado e não pode se repetir em nenhuma hipótese.

 

Preencher com a chave que será utilizada para integração com demais serviços.

conselhoRegional

M

String

Número no conselho regional

Somente números

siglaConselhoRegional

C

String

Sigla do conselho regional

Se conselhoRegional possuir conteúdo, torna-se obrigatório. Tamanho máximo 8 posições

estadoConselhoRegional

C

String

Estado do conselho regional

Se conselhoRegional possuir conteúdo, torna-se obrigatório. Tamanho máximo 2 posições

titulo

M

String

Tratamento com o profissional, exemplo, Dr. Dra. Etc.



sexo

M

Objeto

 

 

dataNascimento

M

String

Data de nascimento do profissional de saúde

Formato: YYYY-MM-DD

cpf

M

String

CPF do profissional de saúde. Apenas números, sem máscara

Somente números. 11 posições. 



celular

M

String

Número do celular do profissional de saúde

Tamanho mínimo / máximo 11 posições. Somente números

especialidades

M

Array de objeto "especialidade"

Retorna uma lista de estruturas “especialidade“ (definição abaixo), caso o usuário possua mais de um contrato

Ao menos um conteúdo válido.

codigoContrato

M

String

Código que identifica de qual contrato esse usuário está vinculado. 

Este código deve ser o mesmo do campo numeroContrato da estrutura “contratos“

email

M

String

Email do profissional de saúde

Email válido.

 

Objeto “especialidades”

  • Objeto “especialidade” que está contido no array de objetos “profissionaisSaude”;

  • Estrutura que contém todo os contratos que o usuário logado está vinculado.

"profissionaisSaude": [ { "especialidades": [ { "cboEspecialidadeId": "string", "cboEspecialidadeDescricao": "string" } ] } ]

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

cboEspecialidadeId

M

String

Código CBO, ou código equivalente.

Formato: Texto livre.

cboEspecialidadeDescricao

M

String

Descrição para ser apresentada ao usuário da solução. 

Formato: Texto livre.

 

Retornar ao índice

 

Objeto “contratos”

"contratos": [ { "descricaoContrato": "string", "numeroContrato": "string", "empresaContratante": {objeto}, "tipoPessoa": {objeto}, "tipoRelacionamento": {objeto}, "tipoContratante": {objeto}, "dataInicioVigenciaContrato": "string", "dadosTitular": {objeto} }, { "descricaoContrato": "string", "numeroContrato": "string", "empresaContratante": {objeto}, "tipoPessoa": {objeto}, "tipoRelacionamento": {objeto}, "tipoContratante": {objeto}, "dataInicioVigenciaContrato": "string", "dadosTitular": {objeto} }, { "descricaoContrato": "string", "numeroContrato": "string", "tipoPessoa": {objeto}, "empresaContratante": {objeto}, "tipoRelacionamento": {objeto}, "tipoContratante": {objeto}, "dataInicioVigenciaContrato": "string", "dadosTitular": {objeto} } ]

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricaoContrato

C

String

 

Formato: Texto livre.

Obrigatório se o tipo for 'beneficiario'.

numeroContrato

M

String

Preencher com a chave relacionada aos atributos de "codigoContrato" dos objetos beneficiario e profissionalSaude.

ASCII (nao permite especiais).

empresaContratante

C

Objeto

 

Formato: Objeto.

Obrigatório se o tipo for 'beneficiario'.

tipoPessoa

C

Objeto

 

Obrigatório se o tipo for 'beneficiario'.

dataInicioVigenciaContrato

C

String

 

Formato: YYYY-MM-DD

Obrigatório se o tipo for 'beneficiario'.

tipoContratante

M

Objeto

preencha de acordo com a tabela ao lado.

 

tipoRelacionamento

M

Objeto

 

Informe o tipo de relacionamento conforme o usuário logado.

dadosTitular

C

Objeto "dadosTitular"

 

Obrigatório se o tipo for 'beneficiario'.

codigoLocalAtendimento

OP

String

Código referente ao local de atendimento

 

 

Objeto “empresaContratante”

  • Objeto “empresaContratante” que está contido no array de objetos “contratos”;

"contratos": [ { "empresaContratante": { "codigo": "string", "descricao": "string" } } ]

 

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

código da empresa

descricao

 

String

 

nome da empresa

 

Objeto “tipoPessoa”

  • Objeto “tipoPessoa” que está contido no array de objetos “contratos”;

"contratos": [ { "tipoPessoa": { "codigo": "string", "descricao": "string" } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

Código para o tipo de pessoa (J, F)

descricao

 

String

 

descrição do tipo de pessoa (Jurídica ou física)

 

Objeto “tipoRelacionamento”

  • Objeto “tipoRelacionamento” que está contido no array de objetos “contratos”;

  • Importante: O tipo de relacionamento informado deve ser com relação ao USUÁRIO LOGADO, em relação aos contratos que ele possui.

    • Exemplo: Beneficiário logado possui 2 contratos ativos, nos quais em um deles é titular e em outro é responsável financeiro

      • Contrato 1: envie 1 = Titular

      • Contrato 2: envie 3 = Responsável financeiro

"contratos": [ { "tipoRelacionamento": { "codigo": "string", "descricao": "string" } } ]

Artributo

Critério

Tipo

Descrição

Regra de preenchimento

Artributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

string

 

código do tipo de relacionamento (1, 2, 3)

descricao

 

string

 

Conteúdo válido:
1 = titular
2 = dependente
3 = responsável financeiro

 

Objeto “tipoContratante”

  • Objeto “tipoContratante” que está contido no array de objetos “contratos”;

"contratos": [ { "tipoContratante": { "codigo": "string", "descricao": "string" } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

 

String

 

Código do tipo do contratante (1, 2, 3)

descricao

 

String

 

Conteúdo válido:
1 = beneficiario
2 = profissional de saude
3 = empresa

 

Objeto “dadosTitular”

  • Objeto “dadosTitular” que está contido no array de objetos “contratos”;

"contratos": [ { "dadosTitular": { "matricula": "string", "nome": "string", "email": "string", "telefone": "string", "celular": "string", "cpf": "string" } } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

matricula

M

String

Matrícula do titular. Informar a matrícula completa, sem espaços ou caracteres especiais

 

ASCII (nao permite especiais - sem acentos, por exemplo).

nome

M

String

Nome do titular

Formato: Texto livre.

email

OP

String

Email do titular 

Email válido

telefone

OP

String

Indique o telefone do titular

Tamanho mínimo 10 / máximo 11 posições. Somente números

celular

OP

String

Número do celular do titular

Tamanho mínimo / máximo 11 posições. Somente números

cpf

OP

String

CPF do profissional de saúde. Apenas números, sem máscara

Somente números. 11 posições.

 

Retornar ao índice

Objeto “segmentacao”

"segmentacao": [ {     “chave”: string,     “chaveDescricao”: string,     “valor”: string,     “valorDescricao”: string,    } ]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chave

M

String

nome do atributo que especifica o segmento

deve ser com letra minusculas, sem espaço ou caracter especial. É permitido de “_“ (underline)

chaveDescricao

OP

String

nome do atributo que especifica o segmento para leitura humana

 Texto livre, caso esteja vazio, irá exibir ao usuário a chave

valor

M

String

valor do atributo que especifica o segmento

Texto livre

valorDescricao

OP

String

valor do atributo que especifica o segmento para leitura humana

Texto livre, caso esteja vazio, irá exibir ao usuário o valor

 

Exemplo de implementação
“segmentacao”: [   {     “chave”: “patologia”,     “chaveDescricao”: “Patologia”,     “valor”: “A02”,     “valorDescricao”: “Diabete”,   } ],

Retornar ao índice

 

Objeto “mosia”

"mosia": { "codigoAgente": "string", "codigoFila": "string", "codigoPerfil": "string" }

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigoAgente

OP

String

 

 

codigoFila

OP

String

 

 

codigoPerfil

OP

String

 

 

 

Retornar ao índice

 

Objeto “agenteRelacionamento”

  • Este objeto é opcional;

  • Essa estrutura é um objeto e pode conter somente um agente.

  • Esta estrutura contém as informações de contato do agente de relacionamento da conta do usuário. Essas informações aparecerão em destaque na área de contatos do aplicativo e do portal.

  • Se não for informado nenhum e-mail ou telefone, a informação não será apresentada na área de contatos.

  • Atente-se as orientações fornecidas pela Mobile Saúde;

  • Atente-se as orientações de segurança e permissões;

  • 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;

"agenteRelacionamento": { "nome": "string", "telefone": "string", "whatsapp": "string", "email": "string", "linkFoto": "string", "tituloApresentacao": "string" }

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

nome

M

String

Indique o nome do gestor de relacionamento

Não permite números

telefone

M

String

Indique o telefone do gestor de relacionamento

 

Tamanho mínimo 10 / máximo 11 posições. Somente números

whatsapp

OP

String

Indique o whatsapp do gestor de relacionamento

Tamanho mínimo 10 / máximo 11 posições. Somente números

email

M

String

Indique o email do gestor de relacionamento

Regras de e-mail

linkFoto

OP

String

Indique uma URL ativa de internet com a imagem para a foto do gestor de relacionamento.

URL válida

tituloApresentacao

M

String

Texto de apresentação para ser divulgado na rotina

Formato: Texto livre.

 

Retornar ao índice

 

Exemplo retorno API - sucesso

{ "seguranca": { "auth": [ { "chave": "Authorization", "token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk" }, { "chave": "Authorization-Custom", "token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk", "expiracao": 1574366666921 } ] }, "usuarioLogado": { "permissoes": [ { "funcionalidade": "0", "acesso": true, "mensagemBloqueio": null, "ocultar": false } ], "login": "123", "chaveUnica": "19430492039", "contato": { "email": "geraldo@mobilesaude.com.br", "telefoneCelular": "27999826284", "telefoneFixo": "2733778899" }, "esquemaCor": "esquema-premium", "integracao": { "xpto": "voluptatibus", "xyz": "quibusdam", "abcdef": 9288701 } }, "beneficiarios": [ { "chaveUnica": "19430492039", "integracao": { "xpto": "voluptatibus", "xyz": "quibusdam", "abcdef": 9288701 }, "dadosPessoais": { "nome": "Geraldo Felix Junior", "dataNascimento": "2017-11-05", "cpf": "92188083970", "nomeMae": "Geraldina Mother Felix", "sexo": { "codigo": "F", "descricao": "Feminino" }, "contato": { "email": "geraldo@mobilesaude.com.br", "telefoneCelular": "27999826284", "telefoneFixo": "2733778899" }, "estadoCivil": { "codigo": "C", "descricao": "Casado" } }, "dadosDoContrato": { "numeroContrato": "99991" }, "dadosDoPlano": { "beneficiario": true, "idPlano": "01", "descricao": "Plano Básico", "registroAns": "999.999/99-9", "segmentacao": "Ambulatorial + Hospitalar com obstetrícia", "acomodacao": "Individual", "tipoContratacao": "Plano Coletivo Empresarial", "regulamentacao": "Plano Regulamentado", "abrangencia": "Estadual", "modalidadeCobranca": "Pós-pagamento", "padraoConforto": "", "participativo": false, "dataInicioVigenciaPlano": "2012-01-01", "dataFinalCpt": "Não há", "dataInclusao": "1990-08-05", "matricula": "2320170425162943-0", "matriculaAntiga": null, "matriculaFuncionario": null, "tipoUsuario": { "codigo": "D", "descricao": "Dependente" }, "grauParentesco": { "codigo": "01", "descricao": "Conjuge" }, "redeAtendimento": { "codigo": "01", "descricao": "XPTO" }, "carencias": [ { "tipoServico": "ES - Atendimentos Ambulatoriais", "carencia": "2012-12-31" }, { "tipoServico": "ES - Internações e Outros Procedimentos", "carencia": "2012-12-31" }, { "tipoServico": "ES - Partos a Termo", "carencia": "2012-12-31" }, { "tipoServico": "ES - Odontologia", "carencia": "2012-12-31" } ] }, "cartao": { "modeloCartao": "plano_basico", "numeroCartao": "00010002000001000", "validade": "2021-02-15", "via": 1, "numeroCns": "999999999999999", "apresentaCartaoVirtual": true, "nomeCartao":"Geraldo F. Junior", "nomeSocialCartao":"Geraldo F. Junior", "operadoraContratada":"XPTO", "convenioAnsContratada":"123123", "seed":"OJQW43TJMVZGY2LOMRXWIZLCN5XGS5DPJBQWQYLIME======", "convenioAbrangenciaVerso":"São Paulo, Guarulhos, Santo André, São Bernardo,São Caetano, Diadema, Mauã, Ribeirão Pires", "compartilhamentoRisco": { "riscoAtivo": true, "operadoraOrigem": 'OPERADORA FICTICIO', "convenioAnsOrigem": 'XXXX', } }, "bloqueio": { "bloqueado": true, "dataBloqueio": "2012-01-01", "motivo": "desligamento da empresa contratante" }, "custom": { "minha_chave_customizada": "Meu valor customizado", "minha_chave_customizada_2": "Meu valor customizado 2", "minha_chave_customizada_3": "Meu valor customizado 3" } } ], "profissionaisSaude": [ { "nome": "Derlandy Belchior", "chaveProfissionalSaude": "63718245", "conselhoRegional": "63718245", "siglaConselhoRegional": "CRM", "estadoConselhoRegional": "ES", "titulo": "Dr", "sexo": { "codigo": "F", "descricao": "Feminino" }, "dataNascimento": "1985-01-01", "cpf": "99999999900", "celular": "27999826284", "especialidades": [ { "cboEspecialidadeId": "2.2.5.1.20", "cboEspecialidadeDescricao": "Cardiologia" } ], "codigoContrato": "00100200300400500609", "email": "derlandy@mobilesaude.com.br" } ], "contratos": [ { "descricaoContrato": "Plano Básico", "numeroContrato": "00100200300400500609", "empresaContratante": { "codigo": "03", "descricao": "Mobile Saúde" }, "tipoPessoa": { "codigo": "J", "descricao": "Pessoa Jurídica" }, "tipoRelacionamento": { "codigo": "3", "descricao": "Responsavel financeio" }, "tipoContratante": { "codigo": "3", "descricao": "Empresa" }, "dataInicioVigenciaContrato": "2012-01-01", "dadosTitular": { "matricula": "2320170425162943-0", "nome": "Derlandy Belchior", "email": "derlandy@mobilesaude.com.br", "telefone": "8646166114", "celular": "27999826284", "cpf": "92188083970" } }, { "descricaoContrato": "Plano Gold Familia", "numeroContrato": "00100200300400500608", "empresaContratante": { "codigo": "03", "descricao": "Mobile Saúde" }, "tipoPessoa": { "codigo": "J", "descricao": "Pessoa Jurídica" }, "tipoRelacionamento": { "codigo": "3", "descricao": "Responsavel financeio" }, "tipoContratante": { "codigo": "3", "descricao": "Empresa" }, "dataInicioVigenciaContrato": "2012-01-01", "dadosTitular": { "matricula": "2320170425162943-0", "nome": "Derlandy Belchior", "email": "derlandy@mobilesaude.com.br", "telefone": "8646166114", "celular": "27999826284", "cpf": "92188083970" } }, { "descricaoContrato": "Plano Sênior", "numeroContrato": "00100200300400500607", "tipoPessoa": { "codigo": "F", "descricao": "Pessoa Física" }, "empresaContratante": { "codigo": "03", "descricao": "Mobile Saúde" }, "tipoRelacionamento": { "codigo": "3", "descricao": "Responsavel financeio" }, "tipoContratante": { "codigo": "2", "descricao": "Empresa" }, "dataInicioVigenciaContrato": "2012-01-01", "dadosTitular": { "matricula": "2320170425162943-0", "nome": "Derlandy Belchior", "email": "derlandy@mobilesaude.com.br", "telefone": "8646166114", "celular": "27999826284", "cpf": "92188083970" } } ], "segmentacao": [ { "chave": "0101", "chaveDescricao": "chave descricao", "valor": "Plano básico", "valorDescricao": "Valor Descricao" }, { "chave": "0101", "chaveDescricao": "chave descricao", "valor": "valor", "valorDescricao": "Valor Descricao" } ], "mosia": { "codigoAgente": null, "codigoFila": null, "codigoPerfil": null }, "agenteRelacionamento": { "nome": "Salomé Irene Godói Jr.", "telefone": "34940972035", "whatsapp": "47984672759", "email": "carolina.mascarenhas@salas.com.br", "linkFoto": "https://randomuser.me/api/portraits/women/17.jpg", "tituloApresentacao": "Beneficiário" } }

 

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

  • Atente-se as mensagens de retorno para cada HTTPS Status Code; Para que a mensagem de falha seja exibida, é necessário devolver um STATUS CODE diferente de 200 (OK). Recomendamos usar o STATUS CODE do grupo 400.

Objetos e atributos de retorno

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

status

M

String

 

Devolva False quando desejar exibir a mensagem de erro.

mensagem

M

String

Utilize esse atributo para escrever a mensagem que será exibida para o usuário do app.

Texto livre. Indique uma mensagem de erro que forneça orientações ao usuário do app.

Exemplo: “Usuário ou senha inválidos”.

 

Entenda que mensagens de erros muito detalhadas podem ajudar muito seu usuário final na localização de um problema no ato do login. Porém, se a mensagem for muito esclarecedora, pode facilitar também a ação de hackers. Mensagens como “Usuário/senha inválidos” conseguem ajudar o usuário, sem revelar QUAL dos 2 está errado.

 

Exemplo retorno API - falha

{ "status": "false", "mensagem": "Login ou senha inválidos" }

 

Utilize sempre HTTP STATUS CODE 403 para credenciais inválidas

Related content

Mobile Saúde - Mosia Omnichannel