1.1 - Login

O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado.

O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.

Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array

exemplo.com/login

POST

application/json

Endpoint de login

login

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

senha

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.

seguranca

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

Objeto usuarioLogado

Usuário que efetuou login

Objeto precisa ter sua estrutura completamente preenchida.

beneficiarios

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

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

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

Array de objetos "segmentacao”

mosia

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

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

auth

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

chave

String

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

 ASCII (nao permite especiais)

token

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

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)

login

String

A mesma informação digitada pelo usuário

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

chaveUnica

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.

integracao

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

Objeto "contato”

esquemaCor

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

Array de objeto "permissoes"

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

email

String

Indique o email do usuario logado

Email precisa ser válido 

telefoneCelular

String

Indique o telefone celular do usuário logado

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

telefoneFixo

String

Indique o telefone fixo do usuário logado

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

funcionalidade

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

Boolean

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

true/false

mensagemBloqueio

String

Preencha com beneficiario ou profissionalSaude

Só pode ter conteúdo quando acesso = false

ocultar

Boolean

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

true/false

chaveUnica

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.

integracao

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

Objeto "dadosPessoais"

dadosDoContrato

Objeto "dadosDoContrato"

dadosDoPlano

Objeto "dadosDoPlano"

cartao

Objeto "cartao"

bloqueio

Objeto "bloqueio"

custom

Objeto "custom"

nome

String

Nome do beneficiário

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

sexo

Objeto

objeto com codigo e descricao do sexo do beneficiário

dataNascimento

String

Data de nascimento do beneficiário

Formato: YYYY-MM-DD

contato

Objeto contato

cpf

String

CPF do beneficiário

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

estadoCivil

Objeto

nomeMae

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.

codigo

String

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

descricao

String

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

email

String

Indique o email do usuario logado

Email precisa ser válido 

telefoneCelular

String

Indique o telefone celular do usuário logado

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

telefoneFixo

String

Indique o telefone fixo do usuário logado

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

codigo

String

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

descricao

String

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

numeroContrato

String

beneficiario

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

String

Formato: Texto livre

descricao

String

Formato: Texto livre

registroAns

String

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

Formato: Texto livre

segmentacao

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

String

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

Formato: Texto livre.

tipoContratacao

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

String

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

Formato: Texto livre.

abrangencia

String

Formato: Texto livre.

modalidadeCobranca

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

String

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

Formato: Texto livre.

participativo

Boolean

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

True/False

dataInicioVigenciaPlano

String

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

Formato: YYYY-MM-DD

dataFinalCpt

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

String

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

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

matricula

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

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

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

Objeto

grauParentesco

Objeto

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

Indicar o ID do grau de parentesco.

redeAtendimento

Objeto

carencias

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

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

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.

codigo

String

Código da rede de atendimento

Formato: Texto livre.

descricao

String

Descrição da rede de atendimento

Formato: Texto livre.

tipoServico

String

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

Formato: Texto livre.

carencia

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.

modeloCartao

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

String

validade

String

Informe a data de validade do cartão

Formato: YYYY-MM-DD

via

Number

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

Somente números inteiros

numeroCns

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

Boolean

True/False

nomeCartao

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

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

String

Informe a operadora contratada.

Formato: Texto livre.

convenioAnsContratada

String

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

Formato: Texto livre.

seed

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

String

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

Formato: Texto livre.

bloqueado

Boolean

True/False

dataBloqueio

String

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

motivo

String

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

chave

String

Nome da propriedade

Formato: Texto livre. Importante: SEMPRE ENVIAR COMO STRING

valor

String

Valor da propriedade

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

nome

String

Nome do contrato

Não permite números 

chaveProfissionalSaude

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

String

Número no conselho regional

Somente números

siglaConselhoRegional

String

Sigla do conselho regional

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

estadoConselhoRegional

String

Estado do conselho regional

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

titulo

String

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

sexo

Objeto

dataNascimento

String

Data de nascimento do profissional de saúde

Formato: YYYY-MM-DD

cpf

String

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

Somente números. 11 posições. 

celular

String

Número do celular do profissional de saúde

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

especialidades

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

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

String

Email do profissional de saúde

Email válido.

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.

descricaoContrato

String

Formato: Texto livre.

Obrigatório se o tipo for 'beneficiario'.

numeroContrato

String

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

ASCII (nao permite especiais).

empresaContratante

Objeto

Formato: Objeto.

Obrigatório se o tipo for 'beneficiario'.

tipoPessoa

Objeto

Obrigatório se o tipo for 'beneficiario'.

dataInicioVigenciaContrato

String

Formato: YYYY-MM-DD

Obrigatório se o tipo for 'beneficiario'.

tipoContratante

Objeto

preencha de acordo com a tabela ao lado.

tipoRelacionamento

Objeto

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

dadosTitular

Objeto "dadosTitular"

Obrigatório se o tipo for 'beneficiario'.

codigoLocalAtendimento

String

Código referente ao local de atendimento

codigo

String

código da empresa

descricao

String

nome da empresa

codigo

String

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

descricao

String

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

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

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

matricula

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

String

Nome do titular

Formato: Texto livre.

email

String

Email do titular 

Email válido

telefone

String

Indique o telefone do titular

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

celular

String

Número do celular do titular

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

cpf

String

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

Somente números. 11 posições.

chave

String

nome do atributo que especifica o segmento

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

chaveDescricao

String

nome do atributo que especifica o segmento para leitura humana

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

valor

String

valor do atributo que especifica o segmento

Texto livre

valorDescricao

String

valor do atributo que especifica o segmento para leitura humana

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

codigoAgente

String

codigoFila

String

codigoPerfil

String

nome

String

Indique o nome do gestor de relacionamento

Não permite números

telefone

String

Indique o telefone do gestor de relacionamento

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

whatsapp

String

Indique o whatsapp do gestor de relacionamento

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

email

String

Indique o email do gestor de relacionamento

Regras de e-mail

linkFoto

String

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

URL válida

tituloApresentacao

String

Texto de apresentação para ser divulgado na rotina

Formato: Texto livre.

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”.