| Índice |
|---|
Informações
Avisos
- Só são suportadas integrações no padrão REST.
- 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.
...
| 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 |
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/login
| POST | application/json | Endpoint de login |
Parâmetros de entrada
...
| Aviso | ||
|---|---|---|
| ||
SOBRE 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. |
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.
Objeto principal
...
Boolean
...
M
...
Objeto usuarioLogado
...
Objeto precisa ter sua estrutura completamente preenchida.
...
Array de objetos "beneficiario"
...
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
...
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
...
Array de objetos "contrato"
...
Deve-se ter no mínimo 1 ocorrência válida, que tenha relação com um elemento do array "beneficiario" ou "profissionalSaude"
...
Objeto "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
...
Array de objetos "agenteRelacionamento"
...
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
...
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 usuariologado
Essa estrutura contém os dados do usuário logado.
SOBRE 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. Lembrando que a tabela de funcionalidades está no final do documento de especificações. Exemplo de uso: 1 - 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 }] 2 - Funcionalidade negada sem mensagem customizada, será exibida uma mensagem padrão "permissoes": [ { "funcionalidade": "1", "acesso": false, "mensagemBloqueio": null, "ocultar": false }] 3 - Funcionalidade oculta no app "permissoes": [ { "funcionalidade": "1", "acesso": false, "mensagemBloqueio": null, "ocultar": true }] 4 - Acesso liberado "permissoes": null |
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.
Objeto principal
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| localizadorMensageriastatus | M | String | Este código será utilizado para registrar o usuário na plataforma de mensageria para envio de notificações. Ele precisa ser um CÓDIGO ÚNICO, capaz de identificar o usuário logado independente de seu contrato ou perfil. Um bom exemplo de código localizador é o CPF do usuário. | ASCII (nao permite especiais - sem acentos, por exemplo) |
| login | M | String | A mesma informação digitada pelo usuário | ASCII (nao permite especiais - sem acentos, por exemplo) |
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema ERP do cliente. Deve existir um objeto idêntico para cada um dos beneficiários no array "beneficiarios". Dessa forma, será possível identificar no sistema ERP do cliente qual usuário está logado. | A regra de preenchimento deve obedecer a estrutura chave / valor. Objetos complexos (array de objetos) não são suportados. |
Objeto beneficiario
Essa estrutura contém os dados básicos de um beneficiário de plano de saúde.
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento | |
|---|---|---|---|---|---|
| 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) | |
| matriculaTitular | M | String | Informe a matrícula do titular Boolean | Indica que o login foi realizado corretamente | true |
| usuarioLogado | M | Objeto usuarioLogado | Usuário que efetuou login | Objeto precisa ter sua estrutura completamente preenchida. | |
| beneficiarios | C | Array de objetos "beneficiario" | 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" | |
| 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 | |
| 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" |
Objeto usuariologado
Essa estrutura contém os dados do usuário logado.
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento | |
|---|---|---|---|---|---|
| localizadorMensageria | M | String | Este código será utilizado para registrar o usuário na plataforma de mensageria para envio de notificações. Ele precisa ser um CÓDIGO ÚNICO, capaz de identificar o usuário logado independente de seu contrato ou perfil. Um bom exemplo de código localizador é o CPF do usuário. | ASCII (nao permite especiais - sem acentos, por exemplo) | . Informar a matrícula do titular da família. Se o beneficio em questão for o próprio titular, repita o conteúdo o campo “matricula”nomeTitular|
| login | M | String | Informe o nome do titularA mesma informação digitada pelo usuário | ASCII (nao permite especiais - sem acentos, por exemplo). Informe o nome do titular da família. Se o beneficio em questão for o próprio titular, repita o conteúdo o campo “nome” | |
| emailTitular | OP | String | Informe o e-mail do titular | Validar com regras de e-mail válido, se preenchido. | |
| telefoneTitular | OP | String | Informe o telefone do titular | Permitir entrada somente números. | |
| celularTitular | OP | String | Informe o telefone celular do titular | Permitir entrada somente números. | |
| cpfTitular | M | String | Informe o CPF do titular | Permitir entrada somente números. Informe o número do CPF do titular da família. Se o beneficio em questão for o | |
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema ERP do cliente. Deve existir um objeto idêntico para cada um dos beneficiários no array "beneficiarios". Dessa forma, será possível identificar no sistema ERP do cliente qual usuário está logado. | A regra de preenchimento deve obedecer a estrutura chave / valor. Objetos complexos (array de objetos) não são suportados. |
Objeto beneficiario
Essa estrutura contém os dados básicos de um beneficiário de plano de saúde.
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 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) | ||||||
| matriculaTitular | M | String | Informe a matrícula do titular | ASCII (nao permite especiais - sem acentos, por exemplo). Informar a matrícula do titular da família. Se o beneficio em questão for o próprio titular, repita o conteúdo o campo “cpf”“matricula” | ||||||
| nomenomeTitular | M | String | Nome Informe o nome do | Não permitir números, nem caracteres especiais. Permitido acentos | nomeSocial titular | ASCII (nao permite especiais - sem acentos, por exemplo). Informe o nome do titular da família. Se o beneficio em questão for o próprio titular, repita o conteúdo o campo “nome” | ||||
| emailTitular | OP | String | Informe o | Não permitir números, nem caracteres especiais. Permitido acentos | sexo | M | String | Informar o sexo do usuário | M = Masculino / e-mail do titular | Validar com regras de e-mail válido, se preenchido. |
| telefoneTitular | C | String | Informe o telefone do titular | Permitir entrada somente números, tamanho mínimo / máximo 10, caso comprado os serviços de MENSAGERIA e/ou TELEMEDICINA este campo torna-se do tipo "M" - Mandatório DDD + NNNNNNNNNN 8646166114 | ||||||
| celularTitular | C | String | Informe o telefone celular do titular | Permitir entrada somente números, tamanho mínimo / máximo 11, caso comprado os serviços de MENSAGERIA e/ou TELEMEDICINA este campo torna-se do tipo "M" - Mandatório DDD + NNNNNNNNNN 27999826284 | ||||||
| cpfTitular | M | String | Informe o CPF do titular | Permitir entrada somente números. Informe o número do CPF do titular da família. Se o beneficio em questão for o próprio titular, repita o conteúdo o campo “cpf” | ||||||
| nome | M | String | Nome do beneficiário | Não permitir números, nem caracteres especiais. Permitido acentos | ||||||
| nomeSocial | OP | String | Informe o nome social do beneficiário | Não permitir números, nem caracteres especiais. Permitido acentos | ||||||
| sexo | M | String | Informar o sexo do usuário | M = Masculino / F = Feminino / N = Não se aplica. Apenas maiúsculos | ||||||
| dataNascimento | M | String | Data de nascimento do beneficiário | Formato: YYYY-MM-DD | ||||||
| cpf | OP | String | CPF do beneficiário | Somente números. Tamanho mínimo / máximo 11 posições. | ||||||
| celular | OP | String | Informar o numero do telefone celular do beneficiário | Tamanho Permitir entrada somente números, tamanho mínimo / máximo 11 . | ||||||
| telefone | OP | String | Informe o número de telefone do beneficiário | Tamanho mínimo / máximo 10. | ||||||
| OP , caso comprado os serviços de MENSAGERIA e/ou TELEMEDICINA este campo torna-se do tipo "M" - Mandatório DDD + NNNNNNNNNN 27999826284 | ||||||||||
| telefone | C | String | Informe o número de telefone do beneficiário | Permitir entrada somente números, tamanho mínimo / máximo 10, caso comprado os serviços de MENSAGERIA e/ou TELEMEDICINA este campo torna-se do tipo "M" - Mandatório DDD + NNNNNNNNNN 8646166114 | ||||||
| C | String | Email precisa ser válido. | ||||||||
| endereco | OP | String | Endereço | Formato: Texto livre. | ||||||
| bairro | OP | String | Bairro | Formato: Texto livre. | ||||||
| cep | OP | String | CEP | Formato: Texto livre. | ||||||
| cidade | M | String | Cidade | Enviar conforme descrição do IBGE | ||||||
| estado | M | String | Estado | Enviar conforme sigla do IBGE (SC, ES, SP, RJ, etc). Tamanho mínimo / máximo 2 posições. Somente letras. Apenas maiúsculas | ||||||
| complemento | OP | String | Complemento do endereço | Formato: Texto livre. | ||||||
| numeroEndereco | OP | String | Número do endereço | Formato: Texto livre. | ||||||
| tipoUsuario | M | String | Informe o tipo de usuário | T = Titular / D = Dependente / A = Agregado. Importante. Só pode existir um (1) usuário no Array de beneficiários com a propriedate tipoUsuario = T por contrato | ||||||
| grauParentescoId | M | String | Código do grau de parentesco do beneficiário em relação ao titular | Indicar o ID do grau de parentesco | ||||||
| grauParentescoDescricao | M | String | Descrição do Grau de Parentesco | Formato: Texto livre. | ||||||
| dataContratacao | M | String | Data da contratação do plano de saúde. Obrigatório PIN-SS conforme RN 389. | Formato: YYYY-MM-DD | ||||||
| dataInicioCobertura | M | String | Data do início da cobertura contratual do beneficiário no plano privado de assistência à saúde. Obrigatório no cartão devido a RN 389 | Formato: YYYY-MM-DD | ||||||
| convenioId | M | String | Código do plano (produto) do usuário. Este código é fundamental para diferenciação da imagem do cartão, direcionamento (segmentação) de campanhas, mensagens e notícias, além de diversas outras funções no aplicativo e web. | Formato: Texto livre. | ||||||
| convenioDescricao | M | String | Texto descritivo do nome do plano (produto) do beneficiário. Informar o nome comercial junto a ANS | Formato: Texto livre. | ||||||
| convenioAbrangencia | OP | String | Texto descritivo do nome da abrangência do plano (produto) do beneficiário. Informar o nome comercial junto a ANSInforme aqui a abrangência (estadual, municipal, grupo de municípios) ou detalhe as informações conforme seu entendimento legal. Obrigatório no cartão devido a RN 389 | Formato: Texto livre. | ||||||
| convenioAbrangenciaVerso | OP | String | Texto descritivo da abrangência contido no verso do cartão do PTU 5.1. Não tem efeito para operadoras fora do sistema Unimed | Formato: Texto livre. | ||||||
| convenioAcomodacao | OP | String | Texto descritivo do padrão de acomodação do plano do beneficiário, conforme ANS | Formato: Texto livre. | ||||||
| convenioModalidadeCobranca | OP | 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. | ||||||
| convenioPadraoConforto | OP | String | Texto descritivo do padrão de conforto do plano (produto) | Formato: Texto livre. | ||||||
| convenioParticipativo | OP | Boolean | Campo para informar se o plano (produto) do beneficiário possui coparticipação ou não. | True/False | ||||||
| convenioSegmentacao | OP | 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. | ||||||
| convenioTipoPessoa | OP | String | Tipo de contrato do plano (produto) do beneficiário Exemplo: Pessoa Física ou Pessoa Jurídica | Formato: Texto livre. | ||||||
| convenioTipoContrato | 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 adesaão ou coletivo empresarial. | Formato: Texto livre. | ||||||
convenioRegulamentacao | M | String | Informação sobre a regulamentação do plano, entendendo-se por: Regulamentado / adaptado / não regulado. | Formato: Texto livre. | ||||||
cartaoValidade | OP | String | Informe textos como "Indefinida" ou "31/12/2020", ou "Vencido" | Formato: Texto livre. | ||||||
cartaoVia | OP | Numérico | Indica o numero da via do cartão vigente do beneficiário | Somente números inteiros | ||||||
| chaveEmpresaContratante | M | String | Código identificador da empresa contratante do plano do beneficiário (nos casos de planos coletivos por adesão ou coletivos empresariais). Importante: nos casos onde o contrato seja de planos individuais/familiares, sugerimos o preenchimento deste atributo com o CPF do contratante. Observação: este código é fundamental para diferenciação da imagem do cartão, direcionamento (segmentação) de campanhas, mensagens e noticias, além de diversas outras funções no aplicativo e web | |||||||
| nomeEmpresaContratante | M | String | Nome da empresa contratante. Importante: nos casos onde o contrato seja de planos individuais/familiares, sugerimos o preenchimento deste atributo com nome completo do contratante. Obrigatório PIN-SS conforme RN 389. | |||||||
| contratoEmpresaContratante | M | String | Numero do contrato/apólice. Obrigatório PIN-SS conforme RN 389. Importante: nos casos onde o contrato seja de planos individuais/familiares, sugerimos o preenchimento deste atributo com a matrícula do contratante. | |||||||
| numeroCns | OP | String | Numero do Cartão Nacional de Saúde. Obrigatório no cartão do beneficiário conforme RN 389. | Formato: Texto livre. | ||||||
| equipeAtendimentoCMS | OP | String | Equipe de Atendimento que poderá ser filtrada em Solicitação de Autorização, Solicitação de Reembolso, Solicitação de Atualização cadastral e Solicitação de 2a via de cartão. | Formato: Texto livre. | ||||||
| convenioAns | OP | String | Número de registro do plano do beneficiário na ANS. | Formato: Texto livre. | ||||||
| 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. | ||||||
| codigoContratoqrCodeCartaoVirtual | M | String | Código que identifica de qual contrato esse usuário está vinculado. | OP | String | Caso sua empresa deseje utilizar QRCode no cartão virtual, inclua neste atributo o conteúdo QRCode no cartão virtual. | Formato: ASCII (Não permite especiais). Envie códigos que sejam interpretáveis por QRCode, além de sua empresa concatenar / separar dados caso necessário. | |||
| codigoContrato | M | String | Código que identifica de qual contrato esse usuário está vinculado. | ASCII (nao permite especiais). Este código deve ser o mesmo do campo codigoContrato da estrutura “contratos“ | ||||||
| redeAtendimento | OP | String | Informe o código e a descrição da Rede de Atendimento do beneficiário Observação PTU 5.1: campo obrigatório | ASCII (nao permite especiais). | ||||||
| modeloCartao | OPC | 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. | ||||||
| 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 | ||||||
| custom | OP | Array de objetos "custom" | ||||||||
| 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. | Atenção! A regra de preenchimento deve obedecer a estrutura chave / valor. Objetos complexos (array de objetos) não são suportados. | ||||||
| cooperativas | OP | Objeto | As cooperativas Unimed, que possuem suas particularidade devem utilizar esse objeto para transacionar informações sobre cartão virtual, e outros temas de relevância para seu negócio. | Preenchimento condicional, se a Unimed necessitar. Empresas fora do sistema Unimed não devem considerar o uso deste objeto. | ||||||
| seed | OP | String | Usado para exibir / calcular o token na funcionalidade de cartão virtual do beneficiário | Só preencha quando for utilizar o token. Recomenda-se utilizar um identificador único por beneficiário (por exemplo, matrícula). Caso deseje utilizar outro conteúdo, entre em contato com a Mobile Saúde. |
Objeto profissionalsaude
Essa estrutura contém os dados básicos de um profissional de saúde de plano de saúde.
...
Estrutura que contém todo os contratos que o usuário logado está vinculado.
...
| Nota |
|---|
...
|
...
String
...
Nome do contrato
...
M
...
String
...
Preencher com a chave relacionada aos atributos de "codigoContrato" dos objetos beneficiario e profissionalSaude.
...
String
...
Preencha com beneficiario ou profissionalSaude
...
Array de objeto "permissoes"
...
Objeto permissoes
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.
...
| ||||||||||||||
Caso a sua Empresa/Operadora faça uso de multi contrato é aqui que deve ser tratado essa questão.
Fluxo login COM multi contrato
Fluxo login SEM multi contrato
|
.PNG?version=1&modificationDate=1641391319586&cacheVersion=1&api=v2&height=250)
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| nome | M | String | Nome do contrato | Não permite números |
| codigoContrato | M | String | Preencher com a chave relacionada aos atributos de "codigoContrato" dos objetos beneficiario e profissionalSaude. | ASCII (nao permite especiais). |
| tipo | M | String | Preencha com beneficiario ou profissionalSaude | Conteúdo válido: beneficiario ou profissionalSaude |
| permissoes | M | Array de objeto "permissoes" | Sigla do conselho regional | Objetos válidos relacionados às funções do app contratado. |
Objeto permissoes
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.
...
| 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) |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"status": true,
"seguranca": {
"auth": [
{
"chave": "Authorization",
"token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk"
},
{
"chave": "Authorization-Custom",
"token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk",
"expiracao": 1574366666921
}
]
},
"usuarioLogado": {
"localizadorMensageria": "derlandy@mobilesaude.com.br",
"login": "derlandy@mobilesaude.com.br",
"integracao": {
"chaveBeneficiario": "2320170425162943",
"ae": "perferendis",
"bd": "repellendus",
"chave_interna": 57293800
}
},
"beneficiarios": [
{
"integracao": {
"chaveBeneficiario": "2320170425162943",
"ae": "voluptatibus",
"bd": "quibusdam",
"chave_interna": 9288701
},
"matricula": "2320170425162943-0",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-0",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "8646166114",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Derlandy Belchior",
"sexo": "F",
"dataNascimento": "2017-11-05",
"cpf": "92188083970",
"celular": "27999826284",
"telefone": "8646166114",
"email": "derlandy@mobilesaude.com.br",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"tipoUsuario": "T",
"grauParentescoId": "01",
"grauParentescoDescricao": "Titular",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Básico",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123222",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99991",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "BENEFICIARIO",
"nomeCartao": "NOME BENEF. VINTECINCOPO",
"nomeSocialCartao": "NOME SOCIAL VINTECINCOPO"
},
"seed": "23201704251629430"
},
{
"integracao": {
"chaveBeneficiario": "2320170425162943-1",
"ae": "animi",
"bd": "distinctio",
"chave_interna": 37949677
},
"matricula": "2320170425162943-1",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-0",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "4937909985",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Conjuge",
"sexo": "F",
"dataNascimento": "1987-11-05",
"cpf": "65612426291",
"celular": "75946497528",
"telefone": "6344767671",
"email": "laura.uchoa@maia.net",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"complemento": "Casa",
"numero": "123",
"tipoUsuario": "D",
"grauParentescoId": "02",
"grauParentescoDescricao": "Esposa(o)",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Básico",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123223",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99991",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "BENEFICIARIO",
"nomeCartao": "NOME BENEF. VINTECINCOPO",
"nomeSocialCartao": "NOME SOCIAL VINTECINCOPO"
},
"seed": "23202222170425162943"
},
{
"integracao": {
"chaveBeneficiario": "2320170425162943-2",
"ae": "deserunt",
"bd": "perspiciatis",
"chave_interna": 2414111
},
"matricula": "2320170425162943-2",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-0",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "6626007527",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Filho(a)",
"sexo": "F",
"dataNascimento": "2012-11-05",
"cpf": "26693601570",
"celular": "75960567928",
"telefone": "9540683952",
"email": "queiros.valeria@hotmail.com",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"complemento": "Casa",
"numero": "123",
"tipoUsuario": "D",
"grauParentescoId": "03",
"grauParentescoDescricao": "Filho(a)",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Básico",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123224",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99991",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "LOWCOST",
"nomeCartao": "NOME BENEF. VINTECINCOPO"
},
"seed": "23202222170425162943"
},
{
"integracao": {
"chaveBeneficiario": "2320170425162943",
"ae": "incidunt",
"bd": "consequatur",
"chave_interna": 323253947
},
"matricula": "2320170425162943-3",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-3",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "2224489673",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Derlandy Belchior",
"sexo": "F",
"dataNascimento": "2012-11-05",
"cpf": "92188083970",
"celular": "27999826284",
"telefone": "2224489673",
"email": "derlandy@mobilesaude.com.br",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"complemento": "Casa",
"numero": "123",
"tipoUsuario": "T",
"grauParentescoId": "01",
"grauParentescoDescricao": "Titular",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Executivo",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123226",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99992",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "COOPERADO",
"nomeCartao": "NOME BENEF. VINTECINCOPO"
},
"seed": "23202222170425162943"
},
{
"integracao": {
"chaveBeneficiario": "2320170425162943-4",
"ae": "eos",
"bd": "excepturi",
"chave_interna": 8
},
"matricula": "2320170425162943-4",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-3",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "7524220598",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Conjuge",
"sexo": "F",
"dataNascimento": "1987-11-05",
"cpf": "65612426291",
"celular": "74937571185",
"telefone": "1343852217",
"email": "melissa.mendonca@ig.com.br",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"complemento": "Casa",
"numero": "123",
"tipoUsuario": "D",
"grauParentescoId": "02",
"grauParentescoDescricao": "Esposa(o)",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Executivo",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123228",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99992",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "BENEFICIARIO"
},
"seed": "23202222170425162943"
},
{
"integracao": {
"chaveBeneficiario": "2320170425162943-5",
"ae": "et",
"bd": "harum",
"chave_interna": 65338931
},
"matricula": "2320170425162943-5",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-3",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "7321384591",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Filho(a)",
"sexo": "F",
"dataNascimento": "2012-11-05",
"cpf": "26693601570",
"celular": "48990552633",
"telefone": "4625317453",
"email": "alonso.pereira@ig.com.br",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"complemento": "Casa",
"numero": "123",
"tipoUsuario": "D",
"grauParentescoId": "03",
"grauParentescoDescricao": "Filho(a)",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Executivo",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123229",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99992",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "BENEFICIARIO"
},
"seed": "23202222170425162943"
},
{
"integracao": {
"chaveBeneficiario": "2320170425162943",
"ae": "perferendis",
"bd": "repellendus",
"chave_interna": 57293800
},
"matricula": "2320170425162943-6",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-6",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "6741119430",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Derlandy Belchior",
"sexo": "F",
"dataNascimento": "2007-11-05",
"cpf": "92188083970",
"celular": "27999826284",
"telefone": "6741119430",
"email": "derlandy@mobilesaude.com.br",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"complemento": "Casa",
"numero": "123",
"tipoUsuario": "T",
"grauParentescoId": "01",
"grauParentescoDescricao": "Titular",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Silver Corporate",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123230",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99993",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "BENEFICIARIO"
},
"seed": "23202222170425162943"
},
{
"integracao": {
"chaveBeneficiario": "2320170425162943-7",
"ae": "est",
"bd": "ipsum",
"chave_interna": 9971
},
"matricula": "2320170425162943-7",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-6",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "8544016063",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Conjuge",
"sexo": "F",
"dataNascimento": "1987-11-05",
"cpf": "65612426291",
"celular": "42986469182",
"telefone": "6321180938",
"email": "gian70@uol.com.br",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"complemento": "Casa",
"numero": "123",
"tipoUsuario": "D",
"grauParentescoId": "02",
"grauParentescoDescricao": "Esposa(o)",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Silver Corporate",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123233",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99993",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "BENEFICIARIO"
},
"seed": "23202222170425162943"
},
{
"integracao": {
"chaveBeneficiario": "2320170425162943-8",
"ae": "corrupti",
"bd": "voluptatem",
"chave_interna": 719
},
"matricula": "2320170425162943-8",
"matriculaAntiga": null,
"matriculaFuncionario": null,
"matriculaTitular": "2320170425162943-6",
"nomeTitular": "Derlandy Belchior",
"emailTitular": "derlandy@mobilesaude.com.br",
"telefoneTitular": "9329153121",
"celularTitular": "27999826284",
"cpfTitular": "92188083970",
"nome": "Filho(a)",
"sexo": "F",
"dataNascimento": "2012-11-05",
"cpf": "26693601570",
"celular": "64966730451",
"telefone": "4133804867",
"email": "tzaragoca@ig.com.br",
"endereco": "Avenida Carolina, 2",
"bairro": "Guilherme do Sul",
"cep": "58895-647",
"cidade": "Natália d'Oeste",
"estado": "PB",
"complemento": "Casa",
"numero": "123",
"tipoUsuario": "D",
"grauParentescoId": "03",
"grauParentescoDescricao": "Filho(a)",
"dataContratacao": "2012-01-01",
"dataInicioCobertura": "2012-01-01",
"convenioId": "01",
"convenioDescricao": "Plano Silver Corporate",
"convenioAbrangencia": "Estadual",
"convenioAbrangenciaVerso": "Estadual",
"convenioAcomodacao": "Individual",
"convenioModalidadeCobranca": "Pós-pagamento",
"convenioPadraoConforto": "",
"convenioParticipativo": false,
"convenioSegmentacao": "Ambulatorial + Hospitalar com obstetrícia",
"convenioTipoPessoa": "Pessoa Jurídica",
"convenioTipoContrato": "Plano Coletivo Empresarial",
"convenioRegulamentacao": "Plano Regulamentado",
"cartaoValidade": "05/11/2022",
"cartaoVia": 1,
"chaveEmpresaContratante": "03",
"nomeEmpresaContratante": "Mobile Saúde",
"contratoEmpresaContratante": "004",
"numeroCns": "999999999999999",
"convenioAns": "999.999/99-9",
"dataFinalCpt": "Não há",
"qrCodeCartaoVirtual": "123123123245",
"carencias": [
{
"tipoServico": "ES - Atendimentos Ambulatoriais",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Internações e Outros Procedimentos",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Partos a Termo",
"carencia": "31/12/2012"
},
{
"tipoServico": "ES - Odontologia",
"carencia": "31/12/2012"
}
],
"codigoContrato": "99993",
"redeAtendimento": null,
"modeloCartao": null,
"custom": [
{
"chave": "minha_chave_customizada",
"valor": "Meu valor customizado"
}
],
"cooperativas": {
"seed": "23202222170425162943",
"unimedContratada": "Unimed Contratada ABC DEF",
"convenioAnsContratada": "1122334",
"layoutCartaoVirtual": "BENEFICIARIO"
},
"seed": "23202222170425162943"
}
],
"profissionaisSaude": [
{
"nome": "Derlandy Belchior",
"chaveProfissionalSaude": "63718245",
"conselhoRegional": "63718245",
"siglaConselhoRegional": "CRM",
"estadoConselhoRegional": "ES",
"titulo": "Dr",
"sexo": "M",
"dataNascimento": "1985-01-01",
"cpf": "99999999900",
"celular": "27999826284",
"especialidades": [
{
"cboEspecialidadeId": "2.2.5.1.20",
"cboEspecialidadeDescricao": "Cardiologia"
}
],
"codigoContrato": "13986450",
"email": "derlandy@mobilesaude.com.br"
}
],
"contratos": [
{
"nome": "Plano Básico",
"codigoContrato": "99991",
"permissoes": [
{
"funcionalidade": "0",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "1",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "2",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "3",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "4",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "5",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "6",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "7",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "8",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "9",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "10",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "11",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "12",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "13",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "14",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "15",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "16",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "39",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "17",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "18",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "29",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "89",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "20",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "21",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "38",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "42",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "48",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "46",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "30",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "31",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "33",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "34",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
}
],
"tipo": "beneficiario"
},
{
"nome": "Plano Executivo",
"codigoContrato": "99992",
"permissoes": [
{
"funcionalidade": "0",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "1",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "2",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "3",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "4",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "5",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "6",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "7",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "8",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "9",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "10",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "11",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "12",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "13",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "14",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "15",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "16",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "39",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "17",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "18",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "29",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "89",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "20",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "21",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "38",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "42",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "48",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "46",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "30",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "31",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "33",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "34",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
}
],
"tipo": "beneficiario"
},
{
"nome": "Plano Silver Corporate",
"codigoContrato": "99993",
"permissoes": [
{
"funcionalidade": "0",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "1",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "2",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "3",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "4",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "5",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "6",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "7",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "8",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "9",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "10",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "11",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "12",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "13",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "14",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "15",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "16",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "39",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "17",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "18",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "29",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "89",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "20",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "21",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "38",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "42",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "48",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "46",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": true
},
{
"funcionalidade": "30",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "31",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "33",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "34",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
}
],
"tipo": "beneficiario"
},
{
"nome": "Cooperado Cooperativas",
"codigoContrato": "13986450",
"permissoes": [
{
"funcionalidade": "102",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "103",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "105",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "106",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "110",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
},
{
"funcionalidade": "32",
"acesso": true,
"mensagemBloqueio": null,
"ocultar": false
}
],
"tipo": "profissional_saude"
}
],
"mosia": {
"callerKey": "derlandy@mobilesaude.com.br",
"callerEmail": "derlandy@mobilesaude.com.br",
"callerName": "Derlandy Belchior",
"callerPhone": "27999826284",
"allocationAgent": null,
"allocationQueue": null,
"customClientDataWidget":[
{
"chave": "Matricula Funcionario",
"valor": "11223344"
},
{
"chave": "Matricula Beneficiário",
"valor": "99998888777"
},
{
"chave": "Cor preferida",
"valor": "Vermelho"
}]
},
"agenteRelacionamento": [
{
"nome": "Salomé Irene Godói Jr.",
"telefone1": "34940972035",
"telefone2": "47984672759",
"email": "carolina.mascarenhas@salas.com.br",
"linkFoto": "https://randomuser.me/api/portraits/women/17.jpg",
"tituloApresentacao": "Beneficiário"
},
{
"nome": "Dr. Isabel Paulina Lozano Neto",
"telefone1": "15973656244",
"telefone2": "4933875727",
"email": "rafael15@zaragoca.com",
"linkFoto": "https://randomuser.me/api/portraits/women/18.jpg",
"tituloApresentacao": "Cooperado"
}
]
}
|
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
...
Boolean
...
...
Envie nesta propriedade o motivo pelo qual o acesso foi negado.
Formato: Texto livre.
Retorno API - Falha
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"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.
| Nota | ||
|---|---|---|
| ||
O Método de "lembrarSenha" foi descontinuado. Em sua substituição, criamos o "reiniciarSenha", também descrito nessa documentação técnica. Portanto, o "lembrarSenha" NÃO DEVE MAIS SER UTILIZADO e encontra-se nesta documentação apenas para fins de compatibilidade com o legado. |
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
| Nota | ||
|---|---|---|
| ||
|
...
POST
...
Endpoint de lembrar senha
Parâmetros de entrada
...
cpf
...
String
...
CPF do usuário
...
dataNascimento
...
M
String
...
Campo data de nascimento.
A ideia é que o cruzamento dos cpf + dataNascimento permita ao sistema identificar o usuário, validar os dados e retornar a senha se tudo estiver ok.
Formato: yyyy-MM-dd
Request body
| Bloco de código |
|---|
{
"cpf": "<cpf>",
"dataNascimento": "<dataNascimento>"
} |
Objetos e atributos de retorno
| Nota | ||
|---|---|---|
| ||
|
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
...
Boolean
...
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.
...
String
Retorna a senha de acesso.
...
String
...
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.
...
String
...
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
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{ "statustituloApresentacao": true, "Beneficiário" }, { "loginnome": "derlandy@mobilesaude.com.br",Dr. Isabel Paulina Lozano Neto", "senhatelefone1": "mobi12315973656244", "emailtelefone2": "derlandy@mobilesaude.com.br4933875727", "telefoneemail": "27999826284rafael15@zaragoca.com", "enviado "linkFoto": false"https://randomuser.me/api/portraits/women/18.jpg", "alerta "tituloApresentacao": null "Cooperado" } ] } |
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
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| status | M | Boolean | Indica que as informações fornecidas pelo usuário não conferem e a recuperação de senha foi mal sucedidao login não foi realizado corretamente. | false |
| motivoCritica | M | String | Motivo pelo qual o acesso foi negado. | Envie nesta propriedade o motivo pelo qual não foi possível lembrar a senhao acesso foi negado. Formato: Texto livre. |
Retorno API - Falha
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"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
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/trocarSenha
| POST | application/json | Endpoint de trocar senha |
Parâmetros de entrada
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| login | M | String | Login do utilizado pelo beneficiário (Ex: CPF) |
senhaAtual | M | String | Senha atual do usuário para que o webservice valide a autenticidade. |
novaSenha | M | String | Nova senha informada pelo usuário. |
| 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. |
Request body
| Bloco de código |
|---|
{
"integracao": {
"<chave>": "<valor>"
}
"login": "<login>"
"senhaAtual": "<senhaAtual>",
"novaSenha": "<novaSenha>"
} |
Objetos e atributos de retorno
| Nota | ||
|---|---|---|
| ||
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 "status":
|
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
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| status | M | Boolean | Indica que a troca da senha foi bem sucedida. | true |
Retorno da API - Sucesso
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"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
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| status | M | Boolean | Indica que a troca de senha foi mal sucedida. | false |
| motivoCritica | M | String | Motivo pelo qual não foi possível trocar a senha. | Formato: Texto livre. |
Retorno API - Falha
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"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
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/novoUsuario
| POST | application/json | Endpoint para criar acesso de novos usuários |
...
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
login | M | String | Id de identificação do usuário. |
dataNascimento | M | String | Campo data de nascimento. A ideia é que o cruzamento dos campos login + DataNascimento permita ao sistema identificar o usuário com segurança para a criação do usuário de acesso. Formato: yyyy-MM-dd |
| senha | M | String | Nova senha, informada pelo usuário. |
| OP | String | E-mail informado pelo usuário. Armazenar essa informação para ser utilizada para recuperação de senha. |
Request body
| Bloco de código |
|---|
{
"login": "<login>",
"dataNascimento": "<dataNascimento>",
"senha": "<senha>”,
“email”: “<email@email.com>"
} |
Objetos e atributos de retorno
| Nota | ||
|---|---|---|
| ||
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":
|
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
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/reiniciarSenha
| POST | application/json | Endpoint para criar acesso de novos usuários |
...
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
login | M | String | Id de identificação do usuário. |
dataNascimento | M | String | Campo data de nascimento. A ideia é que o cruzamento dos campos login + DataNascimento permita ao sistema identificar o usuário com segurança para a criação do usuário de acesso. Formato: yyyy-MM-dd |
| senha | M | String | Nova senha informada pelo usuário. |
| OP | String | E-mail informado pelo usuário. Pode ser usado para verificar os dados junto com o login + dataNascimento. |
Request body
| Bloco de código |
|---|
{
"login": "<login>",
"dataNascimento": "<dataNascimento>",
"senha": "<senha>”,
“email”: “<email@email.com>"
} |
Objetos e atributos de retorno
| Nota | ||
|---|---|---|
| ||
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 "status":
|
Descrição dos objetos e atributos de retorno - Sucesso
Objeto principal
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| status | M | Boolean | Indica que a senha foi reiniciada com sucesso. | true |
Retorno da API - Sucesso
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"status": true
}
|
Descrição dos objetos e atributos de retorno - Falha
Objeto principal
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| status | M | Boolean | Indica que a reinicialização da senha foi mal sucedida. | false |
| motivoCritica | M | String | Motivo pelo qual não foi possível trocar a senha. | Formato: Texto livre. |
Retorno API - Falha
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"status": false,
"motivoCritica": "Dados inválidos, verifique os dados informados"
} |
...
| Descrição | Código |
|---|---|
Notícia | 0 |
InBox ( caixa de notificações ) | 1 |
| Agendamento On-line | 2 |
| Cartão Virtual | 3 |
| Busca de Rede Credenciada | 4 |
| Busca de Medicamento | 5 |
| Prescrições | 6 |
| Alarmes | 7 |
| Contatos | 8 |
| Extrato de Utilização e Coparticipação | 11 |
| Extrato de Autorizações | 13 |
| Débitos (boletos) | 14 |
| Revistas e Manuais | 18 |
| Declarações (IR, Carta de quitação e Carta de permancia) | 20 |
| Componente Cadastral (PIN-SS) Cadastral | 21 |
| Guia Médico Nacional | 24 |
| Navegador Interno (para abrir links dentro do App) | 29 |
| Fila de Espera | 35 |
| Resultado de Exames | 36 |
| Navegador Externo (para abrir links fora do App, diretamente no navegador) | 37 |
| Solicitação de Segunda Via de Cartão | 38 |
| Solicitação de Atualização Cadastral | 39 |
| Solicitação de Cancelamento de Plano | 42 |
| Botão de Emergencia | 43 |
| Chat | 46 |
| Solicitação de Autorização | 48 |
| Cartão Virtual Modelo Unimed Brasil | 55 |
| Reembolso CMS | 56 |
| Extrato Reembolso | 57 |
| Mosia TeleCare | 58 |
| Detalhes do agendamento | 89 |
| Eventos - exclusivo para o perfil de profissional de saúde | 102 |
| Extrato de Pagamento - exclusivo para o perfil de profissional de saúde | 103 |
| Indicação de Ausência - exclusivo para o perfil de profissional de saúde | 105 |
| Programa de Pontos - exclusivo para o perfil de profissional de saúde | 106 |
| Programa de Cursos - exclusivo para o perfil de profissional de saúde | 110 |
...