Histórico da Página
CONTEÚDO
- Visão Geral
- Configurações INI
- Configurações Remote
- Cadastro de Usuários API
- Cadastro de Funcionalidades
- Cadastro de Operadoras
- Cadastro de Bloqueios BG1 e BG3
- Cadastro de Layouts do Cartão
- Cadastro Formas de Pagamento
- Cadastro de Usuários API
- API Primeiro Acesso - createUser
- API Login Beneficiário - auth
- API Lembrar Senha - rememberPass
01. VISÃO GERAL
A integração entre Microsiga Protheus e o App Mobile Saúde tem como objetivo, oferecer aos beneficiários da Operadora algumas funcionalidades de consulta de informações através de seu celular utilizando o App Mobile Saúde. As funcionalidades são:
Operações de Acesso:
- Cadastro de login/senha para o beneficiário (este acesso pode ser utilizado no Portal do Beneficiários Plano de Saúde).
- Login no App com consulta a dados cadastrais.
- Lembrar e troca de senha.
Operações de Utilização:
- Consulta do extrato de utilização.
- Consulta do extrato de co-participação.
Operações Financeiras:
- Consulta aos débitos (títulos financeiros).
- Detalhes do débito.
- Baixar o PDF da extrato da fatura.
- Baixar o PDF com o boleto.
- Consultar a composição de cobrança de uma fatura.
A comunicação entre os sistemas é realizada através de API´s. A documentação técnica dos JSON´s de entrada/saída pode ser encontrada neste link: Definições APIs Mobile Saúde
02. CONFIGURAÇÕES INI
Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:
Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> + /mobileSaude/v1/ + <nome da API>. Exemplo:
Logo, a minha URL de acesso de um beneficiário será: http://spon019400235:8080/rest/mobileSaude/v1/auth.
Segue a lista com todas as API´s disponíveis e o nome da API:
Descrição | Nome da API |
---|---|
API de Segurança para criação de Tokens de Acesso | token |
Primeiro Acesso do Beneficiário (criação de login/senha) | createUser |
Login beneficiário | auth |
Lembrar Senha | rememberPass |
Trocar Senha | changePass |
Lista Débitos (títulos SE1 do beneficiário) | listaDebitos |
Detalhe Débito (informações de um SE1 detalhado) | detalheDebito |
Download PDF Boleto | boletoPDF |
Download PDF Extrato Fatura | extratoFaturaPDF |
Composição Cobrança (detalhamento BM1 de um título) | composicaoCobranca |
Extrato de Utilização | exUtilizacao |
Extrato de Co-participação | exCoparticipacao |
Importante: esta URL com os acessos deve ser informada aos administradores da Mobile Saúde.
03. CONFIGURAÇÕES REMOTE
a) Cadastro de Usuários API
Acesse Plano de Saúde / Mobile Saúde / Cad. Usuários API. Clique em Incluir.
Informe o Nome Usuário e Desc. Usuário e confirme o cadastro:
O sistema gera automaticamente os registros Client ID e Secret Key. Estes registros devem ser encaminhados para o administrador da Mobile Saúde, eles serão utilizados para gerar o Token de Acesso as API´s gerais através da API /token. As chaves de acesso podem ser redefinidas acessando a funcionalidade Outras Ações / Redefinir Chaves.
b) Cadastro de Funcionalidades
Acesse Plano de Saúde / Mobile Saúde / Funcionalidades. Clique em Outras Ações / Carregar Funcionalidades e confirme. As funcionalidades disponíveis na Mobile Saúde são carregadas automaticamente:
É possível desativar uma funcionalidade acessando a Opção Alterar e preenchendo os campos:
Campo | Campo Físico | Descrição Funcionalidade |
---|---|---|
Ativo | B7X_ATIVO | Indica se a funcionalidade está ativa. |
Func Oculta | B7X_OCULTO | Indica se a funcionalidade será apresentada no menu do APP Mobile Saúde quando estiver bloqueada. |
Msg Bloqueio | B7X_MSGBLO | Mensagem impeditiva que será apresentada no APP Mobile Saúde ao acessar uma funcionalidade bloqueada. |
c) Cadastro Operadora de Saúde.
Acesse Plano de Saúde / Operadora / Operadora de Saúde (PLSA010). Selecione a sua Operadora e clique em Alterar, acesse a aba Mobile Saúde. Os campos abaixo são relacionados ao comportamento de sua API:
.
Campo | Campo Físico | Descrição Funcionalidade |
---|---|---|
Mobile Login | BA0_MSTLOG | Informe se o Login do usuário na API é realizado pelo CPF ou Matrícula. Este campo influencia diretamente na criação do registro de Login Portal/Mobile do usuário. Ao acessar a API createUser o sistema cria um registro para o Beneficiário na tabela de Logins BSW. O campo BSW_LOGUSR será criado de acordo com a opção selecionada neste campo. A recomendação padrão é utilizar o Login por CPF. |
MultiContrat | BA0_MSMULT | Define se a Operadora trabalha com o conceito de MultiContrato. Esta opção está disponível está acessível somente quando o tipo de Login é por Matrícula. Este campo define se o usuário terá acesso a todas informações de todas as suas matrículas (caso ele tenha mais uma matrícula na Operadora). Exemplo: Beneficiário A está cadastrado em duas famílias com as matrículas 00010062000005015 e 00010002000002004. Com a opção MultiContrato = Sim, acessando o APP com qualquer de umas matrículas, ele terá acesso a Lista de Débitos de ambas matrículas. |
Mobile Cache | BA0_MSCACH | Indica se habilita a utilização de cache nas APIs de createUser e auth. Com o cache habilitado, quando um beneficiário acessar a API, o JSON de resposta é armazenado em cache e caso o mesmo beneficiário realize a mesma solicitação em até um hora depois, o sistema utiliza a resposta que foi armazenada em cache diminuindo o custo de processamento do servidor. |
Cód Cônjuge | BA0_MSCONJ | Indica o código do Cônjuge no cadastro de beneficiários (usuários com perfil de Cônjuge, ao acessar a API, tem acesso aos dados de todos os beneficiários da família exceto o títular). |
Contato Tit | BA0_MSCONT | Indica se retorna os atributos de contato do titular (celular, telefone e email) ao realizar uma requisição de acesso usuário com um dependente que não tem esses dados preenchidos em seu cadastro. |
Ender Tit | BA0_MSEND | Indica se retorna os atributos de endereço do titular (enderecao, bairro, cep, cidade e estado) ao realizar uma requisição de acesso com um dependente que não tem esses dados preenchidos em seu cadastro. |
Impr Depend | BA0_MSDEPE | Indica se o titular tem acesso aos dados de utilização dos beneficiários dependentes nas APIs de Extrato de Utilização/Coparticipação. |
Exc Pag Bloq | BA0_MSEXPB | Indica se exclui a exibição dos eventos com pagamento médico bloqueado (BD6_BLOCPA = Sim) nas nas APIs de Extrato de Utilização/Coparticipação. |
Exib Tit Pag | BA0_MSTPAG | Indica se serão apresentados títulos já pagos na API listaDebitos. |
Modo PDF | BA0_MSPDFM | Indica como os arquivos PDF´s serão disponibilizados: via download HTTP ou através do Json via Base 64. |
URL PDF | BA0_MSPDFU | Informe a URL do portal HTTP que será disponibilizado os arquivos PDF´s (baseado com sua configuração HTTP no Appserver.ini). |
Acess Portal | BA0_MSACES | Informe o grupo de direitos (Tabela AI3) que será utilizada ao cadastrar um novo login BSW de usuário pela API createUser. |
Perf.Acesso | BA0_MSPERF | Informe o perfil de acesso (Tabela B7I) que será utilizada ao cadastrar um novo login BSW de usuário pela API createUser. |
d) Cadastro de Bloqueios BG1 e BG3
Acesse Plano de Saúde / Bloqueio / Bloqueios de Família (PLSA340). Selecione um bloqueio e clique em Alterar e preencha o campo Ação Login (BG1_LOGIN). Este campo define se os beneficiários bloqueados por esse motivo de bloqueio terão acesso as funcionalidades através do APP.
Acesse Plano de Saúde / Bloqueio / Bloqueios de Beneficiários (PLSA310). Selecione um bloqueio e clique em Alterar e preencha o campo Ação Login (BG3_LOGIN). Este campo define se os beneficiários bloqueados por esse motivo de bloqueio terão acesso as funcionalidades através do APP.
Importante: é necessário parametrizar todos os bloqueios.
e) Cadastros de Layout do Cartão
Os cadastros abaixo influenciam nas APIs createUser e auth que retornam os dados cadastrais, retornando o conteúdo do atributo modeloCartao. O retorno deste atributo é sempre realizado com o Alias configurado mais específico. A ordem dos Alias que serão verificados é (iniciando pelo mais específico):
- Beneficiários - BA1;
- Família - BA3;
- Empresa Contrato Produto - BT6 relacionado ao Beneficiário (BA1);
- Empresa Contrato Produto - BT6 relacionado à família (BA3);
- Subcontrato - BQC;
- Produtos de Saúde - BI3 relacionado ao Beneficiário (BA1);
- Produtos de Saúde - BI3 relacionado à família (BA3).
Alias | Caminho Menu | Passos para Configurar |
---|---|---|
Beneficiários - BA1 | Plano de Saúde / Contrato Família / Grupo Familiar/Beneficiários (PLSA174) |
|
Família - BA3 | Plano de Saúde / Contrato Família / Grupo Familiar/Beneficiários (PLSA174) |
|
Empresa Contrato Produto - BT6 | Plano de Saúde / Contrato Família / Grupo/Empresa (PLSA660) |
|
Subcontrato - BQC | Plano de Saúde / Contrato Família / Grupo/Empresa (PLSA660) |
|
Produtos de Saúde - BI3 | Plano de Saúde / Produto Saúde / Produto Saúde (PLSA800) |
|
f) Cadastro Formas de Pagamento
Acesse Plano de Saúde / Contrato Família / Formas de Pagamento (PLSA005). Selecione o registro desejado e clique em Alterar. Informe o dado desejado no campo Cod Mobile (BQL_CODMOB).
Importante: é necessário parametrizar todas as Formas de Pagamento.
Logo abaixo, vamos realizar um descritivo das APIs disponibilizadas.
Importante: todas as APIs são comunicadas com o verbo Post.
04. API PRIMEIRO ACESSO - createUser
URL - https://<url>:<porta>/rest/mobileSaude/v1/createUser
Esta API é responsável pelo cadastro dos beneficiários no acesso a API e Portal do Beneficiário (ambos usarão o mesmo usuário/senha). Os acessos são cadastrados na tabela BSW.
O login é enviado de acordo com a parametrização realizada no campo Mobile Login (BA0_MSTLOG), sendo o CPF ou Matrícula do beneficiário. Para o cadastro correto do acesso ao Portal do Beneficiário, é necessário preencher também os campos Acess Portal (BA0_MSACES) e Perf.Acesso (BA0_MSPERF).
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "login": "95191329023", "senha": "12345678", "dataNascimento" : "1958-11-05", "email" : "[email protected]" } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true, "contratos": [ { "codigoContrato": "00011060000001", "tipo": "beneficiario", "permissoes": [ { "mensagemBloqueio": null, "ocultar": false, "funcionalidade": "11", "acesso": true }, { "mensagemBloqueio": null, "ocultar": false, "funcionalidade": "13", "acesso": true }, { "mensagemBloqueio": null, "ocultar": false, "funcionalidade": "14", "acesso": true } ], "nome": "GERALDO SOARES" } ], "usuarioLogado": { "localizadorMensageria": "00000094", "login": "95191329023", "integracao": { "tipoUsuario": "T", "chaveBeneficiarioTipo": "CPF", "matriculaVida": "00000094", "multiContract": false, "chaveBeneficiario": "95191329023" } }, "beneficiarios": [ { "matriculaFuncionario": "", "carencias": [], "bairro": "BELA VISTA", "convenioParticipativo": false, "convenioAbrangencia": "", "emailTitular": "", "convenioAns": "", "numeroCns": "244113617410018", "chaveEmpresaContratante": "1", "dataNascimento": "1958-11-05", "convenioPadraoConforto": "", "matricula": "00011060000001019", "nomeTitular": "GERALDO SOARES", "grauParentescoId": "01", "convenioId": "7878", "cidade": "SAO PAULO", "convenioRegulamentacao": "ADAPTADO", "estado": "SP", "convenioTipoContrato": "INDIVIDUAL/FAMILIAR", "cpfTitular": "95191329023", "dataFinalCpt": "- -", "nome": "GERALDO SOARES", "tipoUsuario": "T", "cep": "01311200", "grauParentescoDescricao": "BENEFICIARIO TITULAR", "cartaoValidade": "- -", "contratoEmpresaContratante": "1", "convenioAbrangenciaVerso": "", "modeloCartao": "", "matriculaTitular": "00011060000001019", "dataContratacao": "2003-07-20", "endereco": "AVENIDA PAULISTA - DE 1047 A 186-LADO IM", "convenioAcomodacao": "", "convenioTipoPessoa": "PESSOA JURIDICA", "telefoneTitular": "", "celularTitular": null, "celular": null, "cpf": "95191329023", "telefone": "", "integracao": { "tipoUsuario": "T", "chaveBeneficiarioTipo": "CPF", "matriculaVida": "00000094", "multiContract": false, "chaveBeneficiario": "95191329023" }, "nomeEmpresaContratante": "1", "sexo": "M", "convenioSegmentacao": "", "matriculaAntiga": "", "convenioModalidadeCobranca": "Pre-Pagamento", "cartaoVia": 0, "codigoContrato": "00011060000001", "dataInicioCobertura": "2003-07-20", "email": "", "convenioDescricao": "CONSUMIDORES COM MAIS DE 60" } ] } |
05. API LOGIN BENEFICIÁRIO - auth
URL - https://<url>:<porta>/rest/mobileSaude/v1/auth
Esta API realiza o login de um beneficiário que já tem o cadastro no APP. A API retorna os dados cadastrais do beneficiário:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "login" : "95191329023", "senha" : "25d55ad283aa400af464c76d713c07ad" } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true, "contratos": [ { "codigoContrato": "00011060000001", "tipo": "beneficiario", "permissoes": [ { "mensagemBloqueio": null, "ocultar": false, "funcionalidade": "11", "acesso": true }, { "mensagemBloqueio": null, "ocultar": false, "funcionalidade": "13", "acesso": true }, { "mensagemBloqueio": null, "ocultar": false, "funcionalidade": "14", "acesso": true } ], "nome": "GERALDO SOARES" } ], "usuarioLogado": { "localizadorMensageria": "00000094", "login": "95191329023", "integracao": { "tipoUsuario": "T", "chaveBeneficiarioTipo": "CPF", "matriculaVida": "00000094", "multiContract": false, "chaveBeneficiario": "95191329023" } }, "beneficiarios": [ { "matriculaFuncionario": "", "carencias": [], "bairro": "BELA VISTA", "convenioParticipativo": false, "convenioAbrangencia": "", "emailTitular": "", "convenioAns": "", "numeroCns": "244113617410018", "chaveEmpresaContratante": "1", "dataNascimento": "1958-11-05", "convenioPadraoConforto": "", "matricula": "00011060000001019", "nomeTitular": "GERALDO SOARES", "grauParentescoId": "01", "convenioId": "7878", "cidade": "SAO PAULO", "convenioRegulamentacao": "ADAPTADO", "estado": "SP", "convenioTipoContrato": "INDIVIDUAL/FAMILIAR", "cpfTitular": "95191329023", "dataFinalCpt": "- -", "nome": "GERALDO SOARES", "tipoUsuario": "T", "cep": "01311200", "grauParentescoDescricao": "BENEFICIARIO TITULAR", "cartaoValidade": "- -", "contratoEmpresaContratante": "1", "convenioAbrangenciaVerso": "", "modeloCartao": "", "matriculaTitular": "00011060000001019", "dataContratacao": "2003-07-20", "endereco": "AVENIDA PAULISTA - DE 1047 A 186-LADO IM", "convenioAcomodacao": "", "convenioTipoPessoa": "PESSOA JURIDICA", "telefoneTitular": "", "celularTitular": null, "celular": null, "cpf": "95191329023", "telefone": "", "integracao": { "tipoUsuario": "T", "chaveBeneficiarioTipo": "CPF", "matriculaVida": "00000094", "multiContract": false, "chaveBeneficiario": "95191329023" }, "nomeEmpresaContratante": "1", "sexo": "M", "convenioSegmentacao": "", "matriculaAntiga": "", "convenioModalidadeCobranca": "Pre-Pagamento", "cartaoVia": 0, "codigoContrato": "00011060000001", "dataInicioCobertura": "2003-07-20", "email": "", "convenioDescricao": "CONSUMIDORES COM MAIS DE 60" } ] } |
Ao acessar as APIs createUser e auth, beneficiários titulares terão acesso a todos beneficiários da família, os beneficiários cônjuge terão acesso a todos dependentes e o dependentes, acesso somente ao seu cadastro.
06. API LEMBRAR SENHA - rememberPass
URL - https://<url>:<porta>/rest/mobileSaude/v1/rememberPass
Esta API é responsável para lembrar a senha do beneficiário. Ao solicitar uma requisição para esta API, o PLS retornará uma nova senha para o beneficiário.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "cpf": "95191329023", "dataNascimento": "1958-11-05" } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "senha": "148572", "alerta": " ", "status": true, "telefone": " ", "enviado": false, "email": "[email protected]", "login": "95191329023" } |
07. API TROCAR SENHA - changePass
URL - https://<url>:<porta>/rest/mobileSaude/v1/changePass
Esta API é responsável pela troca de senha dos beneficiários que utilizam o aplicativo.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "login": "95191329023", "senhaAtual": "c0086a2d59642def31185968e7198850", "novaSenha": "teste123" } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true } |
08. API EXTRATO DE UTILIZAÇÃO - exUtilizacao
URL - https://<url>:<porta>/rest/mobileSaude/v1/exUtilizacao
Esta API retorna o extrato de utilização de um beneficiário em um Ano/Mês.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "chaveBeneficiarioTipo": "CPF", "matriculaVida": "00000004", "multiContract": true, "chaveBeneficiario": "44046668458", "tipoUsuario" : "T", "idPeriodo" : "202006", "ano" : "2020", "mes" : "06" } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true, "extrato": [ { "valorServico": "0.69", "nomeExecutante": "HOSPITAL BOM CLIMA", "quantidade": "1.00", "codigoContrato": "00010004000002", "nomeBeneficiario": "AMANDA BARBARA", "codigoEvento": "40303136", "descricaoEvento": "SANGUE OCULTO, PESQUISA NAS FEZES", "dataAtendimento": "2020-06-08", "codigoExecutante": "000004", "cpfCnpjExecutante": 34585221000190, "codigoTipoServico": "000002", "descricaoTipoServico": "EXAMES E TERAPIAS", "matriculaBeneficiario": "00010004000002000" }, { "valorServico": "77.12", "nomeExecutante": "HOSPITAL BOM CLIMA", "quantidade": "1.00", "codigoContrato": "00010004000002", "nomeBeneficiario": "AMANDA BARBARA", "codigoEvento": "10101012", "descricaoEvento": "CONSULTA EM CONSULTORIO", "dataAtendimento": "2020-06-09", "codigoExecutante": "000004", "cpfCnpjExecutante": 34585221000190, "codigoTipoServico": "000001", "descricaoTipoServico": "CONSULTAS", "matriculaBeneficiario": "00010004000002000" }, { "valorServico": "2.42", "nomeExecutante": "HOSPITAL BOM CLIMA", "quantidade": "1.00", "codigoContrato": "00010004000002", "nomeBeneficiario": "AMANDA BARBARA", "codigoEvento": "10106014", "descricaoEvento": "ACONSELHAMENTO GENETICO", "dataAtendimento": "2020-06-11", "codigoExecutante": "000004", "cpfCnpjExecutante": 34585221000190, "codigoTipoServico": "000001", "descricaoTipoServico": "CONSULTAS", "matriculaBeneficiario": "00010004000002000" } ] } |
Importante: os campos Impr Depend (BA0_MSDEPE) e Exc Pag Bloq (BA0_MSEXPB) afetam diretamente o comportamento desta API, a descrição detalhada destes campos está descrita na sessão 3.c deste documento.
09. API EXTRATO DE CO-PARTICIPAÇÃO - exCoparticipacao
URL - https://<url>:<porta>/rest/mobileSaude/v1/exCoparticipacao
Esta API retorna o extrato de co-participação de um beneficiário em um Ano/Mês.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "chaveBeneficiarioTipo": "CPF", "matriculaVida": "00000004", "multiContract": true, "chaveBeneficiario": "44046668458", "tipoUsuario" : "T", "idPeriodo" : "202006", "ano" : "2020", "mes" : "06" } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true, "extrato": [ { "valorCoparticipacao": "0.21", "valorServico": "0.69", "nomeExecutante": "HOSPITAL BOM CLIMA", "quantidade": "1.00", "codigoContrato": "00010004000002", "nomeBeneficiario": "AMANDA BARBARA", "codigoEvento": "40303136", "descricaoEvento": "SANGUE OCULTO, PESQUISA NAS FEZES", "dataAtendimento": "2020-06-08", "codigoExecutante": "000004", "cpfCnpjExecutante": 34585221000190, "codigoTipoServico": "000002", "descricaoTipoServico": "EXAMES E TERAPIAS", "matriculaBeneficiario": "00010004000002000" }, { "valorCoparticipacao": "22.92", "valorServico": "77.12", "nomeExecutante": "HOSPITAL BOM CLIMA", "quantidade": "1.00", "codigoContrato": "00010004000002", "nomeBeneficiario": "AMANDA BARBARA", "codigoEvento": "10101012", "descricaoEvento": "CONSULTA EM CONSULTORIO", "dataAtendimento": "2020-06-09", "codigoExecutante": "000004", "cpfCnpjExecutante": 34585221000190, "codigoTipoServico": "000001", "descricaoTipoServico": "CONSULTAS", "matriculaBeneficiario": "00010004000002000" }, { "valorCoparticipacao": "0.72", "valorServico": "2.42", "nomeExecutante": "HOSPITAL BOM CLIMA", "quantidade": "1.00", "codigoContrato": "00010004000002", "nomeBeneficiario": "AMANDA BARBARA", "codigoEvento": "10106014", "descricaoEvento": "ACONSELHAMENTO GENETICO", "dataAtendimento": "2020-06-11", "codigoExecutante": "000004", "cpfCnpjExecutante": 34585221000190, "codigoTipoServico": "000001", "descricaoTipoServico": "CONSULTAS", "matriculaBeneficiario": "00010004000002000" } ] } |
Importante: os campos Impr Depend (BA0_MSDEPE) e Exc Pag Bloq (BA0_MSEXPB) afetam diretamente o comportamento desta API, a descrição detalhada destes campos está descrita na sessão 3.c deste documento.
10. API LISTA DÉBITOS - listaDebitos
URL - https://<url>:<porta>/rest/mobileSaude/v1/listaDebitos
Esta API
Card documentos | ||||
---|---|---|---|---|
|
05. TABELAS UTILIZADAS
HTML |
---|
<!-- esconder o menu --> <style> div.theme-default .ia-splitter #main { margin-left: 0px; } .ia-fixed-sidebar, .ia-splitter-left { display: none; } #main { padding-left: 10px; padding-right: 10px; overflow-x: hidden; } .aui-header-primary .aui-nav, .aui-page-panel { margin-left: 0px !important; } .aui-header-primary .aui-nav { margin-left: 0px !important; } </style> |