Histórico da Página
...
- 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 - createUsernovoUsuario
- API Login Beneficiário - authlogin
- API Lembrar Reiniciar Senha - rememberPassreiniciarSenha
- API Trocar Senha - changePasstrocarSenha
- API Extrato de Utilização - exUtilizacaoextrato
- API Extrato de Co-Participação - exCoparticipacaoAPI Lista Débitos - listaDebitos
- API Detalhe Débito - detalheDebito
- API Boleto PDF - boletoPdf
- API Extrato Fatura PDF - extratoFaturaPdf
- API Composição Cobrança - composicaoCobranca
- Menus
- Tabelas Utilizadas
01. VISÃO GERAL
...
- 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
...
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) | createUsernovoUsuario | ||
Login beneficiário | authlogin | ||
Lembrar Reiniciar Senha | rememberPassreiniciarSenha | ||
Trocar Senha | changePasstrocarSenha | ||
Lista Débitos (títulos SE1 do beneficiário) | listaDebitos | ||
Detalhe Débito (informações de um SE1 detalhado) | detalheDebito | ||
Download PDF Boleto | boletoPDFboletoPdf | ||
Download PDF Extrato Fatura | extratoFaturaPDF | Composição Cobrança (detalhamento BM1 de um título) | composicaoCobrancaextratoFaturaPdf |
Extrato de Utilização | exUtilizacao | ||
Extrato de Co-participação | exCoparticipacao | ||
extrato |
composicaoCobranca
Importante: esta URL com os acessos deve ser informada aos administradores da Mobile Saúde.
...
Importante: todas as APIs são comunicadas com o verbo Post.
04. API PRIMEIRO ACESSO -
...
novoUsuario
URL - https://<url>:<porta>/rest/mobileSaude/v1/createUsernovoUsuario
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.
...
Ponto de Entrada: PMOBBE01 | |||
---|---|---|---|
Fonte: PMobAutCon | |||
Parâmetros | |||
Variável | Tipo | Obrigatório | Descrição |
cCodigo | Caracter | Sim | Código do registro BSW criado |
Retorno | |||
Variável | Tipo | Obrigatório | Descrição |
Não há retorno |
05. API LOGIN BENEFICIÁRIO -
...
login
URL - https://<url>:<porta>/rest/mobileSaude/v1/authlogin
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:
...
Ponto de Entrada: PMOBBE07 | |||
---|---|---|---|
Fonte: PMobBenef | |||
Parâmetros | |||
Variável | Tipo | Obrigatório | Descrição |
oBeneficiary | JSON Object | Sim | Objeto JSON montado pelo sistema |
Retorno | |||
Variável | Tipo | Obrigatório | Descrição |
cRedeAtend | Caracter | Não | Mensagem que será apresentada no atributo redeAtendimento. |
06. API
...
REINICIAR SENHA -
...
reiniciarSenha
URL - https://<url>:<porta>/rest/mobileSaude/v1/rememberPassreiniciarSenha
Esta API é responsável para lembrar reiniciar a senha do beneficiário. Ao solicitar uma requisição para esta API, o PLS retornará uma nova senha para o beneficiário., com o mesmo já informando a nova senha. O sistema só realizará a troca de senha se os atributos login, dataNascimento e email informados corretamente.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
Bloco de código | ||||||
| ||||||
{ "cpflogin": "9519132902363369527030", "dataNascimento": "19581985-11-0506-17", "senha": "12345678", "email": "[email protected]" } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "senha": "148572", "alerta": " ", "status": true, "telefone": " ", "enviado": false, "email": "[email protected]", "login": "95191329023" } |
07. API TROCAR SENHA - changePass
} |
07. API TROCAR SENHA - trocarSenha
URL - https://<url>:<porta>/URL - https://<url>:<porta>/rest/mobileSaude/v1/changePasstrocarSenha
Esta API é responsável pela troca de senha dos beneficiários que utilizam o aplicativo.
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true } |
08. API EXTRATO DE UTILIZAÇÃO -
...
extrato
URL - https://<url>:<porta>/rest/mobileSaude/v1/exUtilizacaoextrato
Esta API retorna o extrato de utilização de um beneficiário em um Ano/Mês. Ela retorna a utilização com/sem a co-participação.
Importante: um registro que tem co-participação é apresentado duas vezes no Json de resposta: uma com o valor zerado e outra com o valor apresentado, de acordo como esperado pelo aplicativo da Mobile Saúde.
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.00", "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": "0.21", "valorServico": "770.1269", "nomeExecutante": "HOSPITAL BOM CLIMA", "quantidade": "1.00", "codigoContrato": "00010004000002", "nomeBeneficiario": "AMANDA BARBARA", "codigoEvento": "1010101240303136", "descricaoEvento": "CONSULTA EM CONSULTORIOSANGUE OCULTO, PESQUISA NAS FEZES", "dataAtendimento": "2020-06-0908", "codigoExecutante": "000004", "cpfCnpjExecutante": 34585221000190, "codigoTipoServico": "000001000002", "descricaoTipoServico": "CONSULTASEXAMES E TERAPIAS", "matriculaBeneficiario": "00010004000002000" }, { "valorCoparticipacao": "0.00", "valorServico": "277.4212", "nomeExecutante": "HOSPITAL BOM CLIMA", "quantidade": "1.00", "codigoContrato": "00010004000002", "nomeBeneficiario": "AMANDA BARBARA", "codigoEvento": "1010601410101012", "descricaoEvento": "ACONSELHAMENTOCONSULTA EM GENETICOCONSULTORIO", "dataAtendimento": "2020-06-1109", "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": "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", "valorCoparticipacaocodigoExecutante": "0.21000004", "valorServicocpfCnpjExecutante": "0.69"34585221000190, "nomeExecutantecodigoTipoServico": "HOSPITAL BOM CLIMA000001", "quantidadedescricaoTipoServico": "1.00CONSULTAS", "codigoContratomatriculaBeneficiario": "0001000400000200010004000002000", }, { "nomeBeneficiariovalorCoparticipacao": "AMANDA BARBARA0.00", "codigoEventovalorServico": "403031362.42", "descricaoEventonomeExecutante": "SANGUEHOSPITAL OCULTO, PESQUISA NAS FEZESBOM CLIMA", "dataAtendimentoquantidade": "2020-06-081.00", "codigoExecutantecodigoContrato": "00000400010004000002", "cpfCnpjExecutantenomeBeneficiario": "AMANDA 34585221000190BARBARA", "codigoTipoServicocodigoEvento": "00000210106014", "descricaoTipoServicodescricaoEvento": "EXAMESACONSELHAMENTO E TERAPIASGENETICO", "matriculaBeneficiariodataAtendimento": "00010004000002000" }, {2020-06-11", "valorCoparticipacaocodigoExecutante": "22.92000004", "valorServicocpfCnpjExecutante": "77.12"34585221000190, "nomeExecutantecodigoTipoServico": "HOSPITAL BOM CLIMA000001", "quantidadedescricaoTipoServico": "1.00CONSULTAS", "codigoContratomatriculaBeneficiario": "0001000400000200010004000002000", } "nomeBeneficiario": "AMANDA BARBARA",] } |
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 LISTA DÉBITOS - listaDebitos
URL - https://<url>:<porta>/rest/mobileSaude/v1/listaDebitos
Esta API retorna todos os títulos financeiros (tabela SE1) relacionados ao usuário selecionado.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "tipoUsuario": "T", "codigoEventochaveBeneficiarioTipo": "10101012CPF", "matriculaVida": "00000005", "multiContract": true, "descricaoEventochaveBeneficiario": "44046668458" } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true"CONSULTA EM CONSULTORIO", "debitos": [ "dataAtendimento": "2020-06-09", { "codigoExecutantedescricao": "000004", "cpfCnpjExecutantevalor": 345852210001904866, "codigoTipoServicotituloId": "000001"6320, "descricaoTipoServicotituloCodigo": "CONSULTASPLS|000000039| |DP ", "matriculaBeneficiariocodigoContrato": "0001000400000200000010004000002", }, {"tipoCobranca": "D", "valorCoparticipacaodataEmissao": "0.722020-06-10", "valorServicodataVencimento": "2.422020-06-10", "nomeExecutantesituacao": "HOSPITAL BOM CLIMAA", "quantidade": "1.00"}, "codigoContrato": "00010004000002",{ "nomeBeneficiariodescricao": "AMANDA BARBARA", "codigoEventovalor": "10106014"216, "descricaoEventotituloId": "ACONSELHAMENTO GENETICO"6364, "dataAtendimentotituloCodigo": "2020-06-11PLS|000000081| |DP ", "codigoExecutantecodigoContrato": "00000400010004000002", "cpfCnpjExecutantetipoCobranca": 34585221000190"D", "codigoTipoServicodataEmissao": "0000012020-08-28", "descricaoTipoServicodataVencimento": "CONSULTAS2020-08-28", "matriculaBeneficiariosituacao": "00010004000002000A" } ] } |
Importante: os campos Impr Depend o campos Exib Tit Pag (BA0_MSDEPE) e Exc Pag Bloq (BA0_MSEXPB) afetam MSTPAG) afeta 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 retorna todos os títulos financeiros (tabela SE1) relacionados ao usuário selecionado.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"tipoUsuario": "T",
"chaveBeneficiarioTipo": "CPF",
"matriculaVida": "00000005",
"multiContract": true,
"chaveBeneficiario": "44046668458"
} |
PONTOS DE ENTRADA
O ponto de entrada PMOBFI01 permite alterar o conteúdo do atributo tipoCobranca:
Ponto de Entrada: PMOBFI01 | |||
---|---|---|---|
Fonte: PMobFinMod | |||
Parâmetros | |||
Variável | Tipo | Obrigatório | Descrição |
cFormRec | Caracter | Sim | Forma de Recebimento definido no campo E1_FORMREC |
nTituloId | Numérico | Não | Recno do registro SE1 |
Retorno | |||
Variável | Tipo | Obrigatório | Descrição |
cTipoCobranca | Caracter | Sim | Tipo de cobrança do título sendo: C = Consignação / desconto em folha |
O ponto de entrada PMOBFI02 permite alterar o conteúdo do atributo situacao:
Ponto de Entrada: PMOBFI02 | |||
---|---|---|---|
Fonte: PMobFinMod | |||
Parâmetros | |||
Variável | Tipo | Obrigatório | Descrição |
nValorBase | Numérico | Não | Valor do título |
dVencto | Data | Não | Data de vencimento |
nTituloId | Numérico | Não | Recno do registro SE1 |
Retorno | |||
Variável | Tipo | Obrigatório | Descrição |
cSituacao | Caracter | Sim | Situação do título sendo: P = A Vencer (em aberto porém ainda não está vencido) |
O ponto de entrada PMOBFI04 permite alterar a query que será processsada ao realizar a busca dos títulos SE1:
Ponto de Entrada: PMOBFI04 | |||
---|---|---|---|
Fonte: PMobFinMod | |||
Parâmetros | |||
Variável | Tipo | Obrigatório | Descrição |
cSql | Caracter | Sim | Query padrão do sistema |
lMultiContract | Boolean | Sim | Indica o MultiContrato está habilitado |
lLoginByCPF | Boolean | Sim | Indica se é login por CPF |
cChaveBeneficiario | Caracter | Sim | Chave do beneficiário enviado no JSON de solicitação. |
Retorno | |||
Variável | Tipo | Obrigatório | Descrição |
cSql | Caracter | Sim | Query que será processada |
O ponto de entrada PMOBFI05 permite alterar o atributo descricao dos títulos processados:
Ponto de Entrada: PMOBFI05 | |||
---|---|---|---|
Fonte: PMobFinMod | |||
Parâmetros | |||
Variável | Tipo | Obrigatório | Descrição |
cPrefixo | Caracter | Sim | Prefixo do título |
cNum | Caracter | Sim | Número do título |
cParcela | Caracter | Sim | Parcela do título |
cTipo | Caracter | Sim | Tipo do título |
Retorno | |||
Variável | Tipo | Obrigatório | Descrição |
cDescricao | Caracter | Não | Valor que será apresentado no atributo descricao |
10. API DETALHE DÉBITO - detalheDebito
URL - https://<url>:<porta>/rest/mobileSaude/v1/detalheDebito
Esta API retorna os dados detalhados de um título SE1 do beneficiário selecionado.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"tituloId": 6353,
| ||||||
Bloco de código | ||||||
| ||||||
{ "status": true, "debitos": [ { "descricao": "", "valor": 4866, "tituloId": 6320, "tituloCodigo": "PLS|000000039| |DP ", "codigoContrato": "00010004000002", "tipoCobranca": "D", "dataEmissao": "2020-06-10", "dataVencimento": "2020-06-10", "situacao": "A" }, { "descricao": "", "valor": 216, "tituloId": 6364, "tituloCodigo": "PLS|000000081000000071| |DP ", } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true, "codigoContratodetalhes": "00010004000002",[ { "tipoCobranca": "D" "situacao": "A", "valor": 578, "valorAtualizado": [], "dataEmissaotextoConfirmacao": "2020-08-28", "dataVencimento": "2020-0806-2810", "situacaoimprimeBoleto": "AN", } "tipoCobranca": "D", ] } |
Importante: o campos Exib Tit Pag (BA0_MSTPAG) afeta diretamente o comportamento desta API, a descrição detalhada destes campos está descrita na sessão 3.c deste documento.
PONTOS DE ENTRADA
O ponto de entrada PMOBFI01 permite alterar o conteúdo do atributo tipoCobranca:
"observacao": "",
"cedenteNome": "OPERADORA 417505",
"linhaDigitavel": "00190500954014481606906809350314337370000000100",
"dataPagamento": ""
}
]
} |
Importante: O atributo linhaDigitavel deve ser gerado através do ponto de entrada PMOBFI03:
Fonte: PMobFinMod | |||
---|---|---|---|
Parâmetros | |||
Parâmetro |
Tipo | Obrigatório | Descrição |
---|
cPrefixo | Caracter |
Não | Prefixo do título |
cNumero | Caracter |
Não |
Número do |
título |
cParcela |
Caracter |
Não |
Parcela do título | |
cTipo | Caracter |
Tipo de cobrança do título sendo:
C = Consignação / desconto em folha
B = Boleto
D = Débito em conta
O ponto de entrada PMOBFI02 permite alterar o conteúdo do atributo situacao:
...
Situação do título sendo:
P = A Vencer (em aberto porém ainda não está vencido)
A = Atrasado (em aberto, porém já vencido)
B = Baixado (já foi pago)
Não | Tipo do título | ||
cBanco | Caracter | Não | Número do banco |
cFormRec | Caracter | Não | Forma de recebimento |
cAgencia | Caracter | Não | Número da agência |
cConta | Caracter | Não | Número da conta |
cDigito | Caracter | Não | Dígito verificador da conta |
cNossoNum | Caracter | Não | Nosso número |
nValLiqui | Numérico | Não | Valor líquido |
cCart | Caracter | Não | Número da Carteira |
cMoeda | Caracter | Não | Tipo da Moeda |
cEspec | Caracter | Não | Máscara da Moeda R$ |
cAceite | Caracter | Não | Aceito |
nTituloId | Numérico | Não | Recno do título |
Retorno | |||
---|---|---|---|
Parâmetro |
O ponto de entrada PMOBFI04 permite alterar a query que será processsada ao realizar a busca dos títulos SE1:
Tipo | Obrigatório | Descrição |
---|
cCodbar | Caracter | Sim |
Query que será processada
O ponto de entrada PMOBFI05 permite alterar o atributo descricao dos títulos processados:
...
Valor que será apresentado no atributo descricao
Retorne a linha digitável |
11. API BOLETO PDF - boletoPdf
URL - https://<url>:<porta>/rest/mobileSaude/v1/boletoPdf
Esta API retorna o PDF referente ao boleto de uma fatura. O boleto pode ser disponibilizado de duas maneiras: informando uma URL para download do arquivo PDF ou codificado em Base 64 através do JSON de resposta. O campo Modo PDF (BA0_MSPDFM) indica o modo que o arquivo será disponibilizado.
Caso seja selecionado o modo de download seja via download HTTP, a URL onde os arquivos PDF´s são disponibilizados devem ser informados no campo URL PDF (BA0_MSPDFU).
Importante: para disponibilizar o download via HTTP é necessário configurar o Portal/Webservice no INI do ambiente. Mais informações de como configurar o ambiente podem ser encontradas neste link: Configurar Portais e Webservices. A recomendação é gerar os arquivos PDFs na pasta \web\pp\imagens-pls\relatorios dentro de seu rootpath.
O Plano de Saúde SIGAPLS, tem um modelo básico de PDF para o boleto. Caso deseje customizar o PDF, a customização pode ser realizada através do ponto de entrada PL580BOL.
Documentação técnica do Ponto de Entrada: TVBPA7_DT_Ponto_de_Entrada_PL580BOL.
Bloco de código | ||
---|---|---|
|
11. API DETALHE DÉBITO - detalheDebito
URL - https://<url>:<porta>/rest/mobileSaude/v1/detalheDebito
Esta API retorna os dados detalhados de um título SE1 do beneficiário selecionado.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "tituloId": 6353, "tituloCodigo": "PLS|000000071| |DP " } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true, "detalhesurl": [ "http://spon019400235:87/pp/imagens-pls/relatorios/boletosc006450.pdf", { "situacao"base64": "A", "valor": 578, "valorAtualizado": [], "textoConfirmacao": "", "dataVencimento": "2020-06-10", "imprimeBoleto": "N", "tipoCobranca": "D", "observacao": "", "cedenteNome": "OPERADORA 417505", "linhaDigitavel": "00190500954014481606906809350314337370000000100", "dataPagamento": "" } ] } |
Importante: O atributo linhaDigitavel é obrigatório e deve ser gerado através do ponto de entrada PMOBFI03:
...
Numérico
...
12. API BOLETO PDF - boletoPdf
URL - https://<url>:<porta>/rest/mobileSaude/v1/boletoPdf
Esta API retorna o PDF referente ao boleto de uma fatura. O boleto pode ser disponibilizado de duas maneiras: informando uma ULR para download do arquivo PDF ou codificado em Base 64 através do JSON de resposta. O campo Modo PDF (BA0_MSPDFM) indica o modo que o arquivo será disponibilizado.
Caso seja selecionado o modo de download seja via download HTTP, a URL onde os arquivos PDF´s são disponibilizados devem ser informados no campo URL PDF (BA0_MSPDFU).
Importante: para disponibilizar o download via HTTP é necessário configurar o Portal/Webservice no INI do ambiente. Mais informações de como configurar o ambiente podem ser encontradas neste link: Configurar Portais e Webservices. A recomendação é gerar os arquivos PDFs na pasta \web\pp\imagens-pls\relatorios dentro de seu rootpath.
O Plano de Saúde SIGAPLS, tem um modelo básico de PDF para o boleto. Caso deseje customizar o PDF, a customização pode ser realizada através do ponto de entrada PL580BOL.
Documentação técnica do Ponto de Entrada: TVBPA7_DT_Ponto_de_Entrada_PL580BOL.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"tituloId": 6353,
"tituloCodigo": "PLS|000000071| |DP "
} |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"status": true,
"url": "http://spon019400235:87/pp/imagens-pls/relatorios/boletosc006450.pdf",
"base64": ""
} |
13. API EXTRATO FATURA PDF - extratoFaturaPdf
URL - https://<url>:<porta>/rest/mobileSaude/v1/extratoFaturaPdf
Similar a API de Boletos, esta retorna o PDF referente ao extrato de uma fatura. As recomendações relacionadas a disponibilização do PDF são as mesmas da sessão 12 - API BOLETO PDF - boletoPdf deste documento.
O Plano de Saúde SIGAPLS, tem um modelo básico de PDF para o extrato. Caso deseje customizar o PDF, a customização pode ser realizada através do ponto de entrada PL580BOL.
Documentação técnica do Ponto de Entrada: TVBPA7_DT_Ponto_de_Entrada_PL580BOL.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"tituloId": 6353,
"tituloCodigo": "PLS|000000071| |DP "
} |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"status": true,
"url": "http://spon019400235:87/pp/imagens-pls/relatorios/boletosc006560.pdf",
"base64": ""
} |
14. API COMPOSIÇÃO COBRANÇA - composicaoCobranca
URL - https://<url>:<porta>/rest/mobileSaude/v1/composicaoCobranca
Esta API traz o detalhamento dos valores de uma cobrança. O detalhamento é baseada na tabela BM1 - Composição da Cobrança.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"tituloId": 6353,
"tituloCodigo": "PLS|000000071| |DP "
} |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"status": true,
"composicao": [
{
"eventos": [
{
"valor": 578,
"observacao": "1013-PRODUTO COBRANCA RETROATIVA",
"codigoVerba": "101",
"descricaoVerba": "PRODUTO/PLANO (MENSALIDADE)",
"debitoCredito": "D"
}
],
"valorTotal": 578,
"nomeBeneficiario": "COBRANCA RETROATIVA",
"grauDependencia": "T",
"matriculaBeneficiario": "00018989000001012"
}
]
} |
15. MENUS
Adicione os menus abaixo:
...
16. TABELAS UTILIZADAS
- Dicionário SX2:
...
- Dicionário SIX:
...
} |
12. API EXTRATO FATURA PDF - extratoFaturaPdf
URL - https://<url>:<porta>/rest/mobileSaude/v1/extratoFaturaPdf
Similar a API de Boletos, esta retorna o PDF referente ao extrato de uma fatura. As recomendações relacionadas a disponibilização do PDF são as mesmas da sessão 12 - API BOLETO PDF - boletoPdf deste documento.
O Plano de Saúde SIGAPLS, tem um modelo básico de PDF para o extrato. Caso deseje customizar o PDF, a customização pode ser realizada através do ponto de entrada PL580BOL.
Documentação técnica do Ponto de Entrada: TVBPA7_DT_Ponto_de_Entrada_PL580BOL.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"tituloId": 6353,
"tituloCodigo": "PLS|000000071| |DP "
} |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"status": true,
"url": "http://spon019400235:87/pp/imagens-pls/relatorios/boletosc006560.pdf",
"base64": ""
} |
13. MENUS
Adicione os menus abaixo:
Menu | Nome Rotina | Função |
---|---|---|
Atualizações / Mobile Saúde | Cad. Usuários API | PLSA99C |
Atualizações / Mobile Saúde | Funcionalidades | PLSA99D |
14. TABELAS UTILIZADAS
- Dicionário SX2:
X2_CHAVE | X2_NOME | X2_MODO | X2_MODOUN | X2_MODOEMP | X2_UNICO |
---|---|---|---|---|---|
B7X | Cad Funcional - Mobile Saude | Compartilhado | Exclusivo | Exclusivo | B7X_FILIAL + B7X_CODOPE + B7X_CODIGO |
B7Y | Usuarios da API - Mobile Saude | Compartilhado | Exclusivo | Exclusivo | B7Y_FILIAL + B7Y_CODOPE + B7Y_CLIID |
BJZ | Tokens Conced - Mobile Saude | Compartilhado | Exclusivo | Exclusivo | BJZ_FILIAL + BJZ_CODOPE + BJZ_TOKEN |
BJV | Cache Requisic - Mobile Saude | Compartilhado | Exclusivo | Exclusivo | BJV_FILIAL + BJV_CODOPE + BJV_LOGIN + BJV_ATIVO |
- Dicionário SIX:
INDICE | ORDEM | CHAVE | DESCRICAO |
---|---|---|---|
B7X | 1 | B7X_FILIAL + B7X_CODOPE + B7X_CODIGO | Operadora + Codigo da funcionalidade |
B7Y | 1 | B7Y_FILIAL + B7Y_CODOPE + B7Y_CLIID | Operadora + Client ID |
BJZ | 1 | BJZ_FILIAL + BJZ_CODOPE + BJZ_TOKEN | Operadora + Token |
BJZ | 2 | BJZ_FILIAL + BJZ_CODOPE + BJZ_CLIID + BJZ_SECRET | Operadora + Client ID + Secret Key |
BJZ | 3 | BJZ_FILIAL + BJZ_CODOPE + BJZ_TOKEN + BJZ_ATIVO | Operadora + Token + Ativo |
BJV | 1 | BJV_FILIAL + BJV_CODOPE + BJV_LOGIN + BJV_ATIVO | Operadora +Login + Ativo |
- Dicionário SX3:
Tabela B7X:
X3_CAMPO | X3_ORDEM | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
B7X_FILIAL | 01 | Caracter | 8 | 0 | Filial | Filial do Sistema | @! | Não | Não | Visual | Real | |||||
B7X_CODOPE | 02 | Caracter | 4 | 0 | Codigo Oper | Código Operadora | @! | Sim | PlsIntPad() | Não | Visual | Real | ||||
B7X_CODIGO | 03 | Caracter | 3 | 0 | Cod. Func | Código Funcionalidade | @! | Sim | Sim | Alterar | Real | |||||
B7X_DESCRI | 04 | Caracter | 100 | 0 | Descricao | Descrição | @! | Sim | Sim | Alterar | Real | |||||
B7X_ATIVO | 05 | Caracter | 1 | 0 | Ativo | Ativo | @! | Sim | 0=Não;1=Sim | Sim | Alterar | Real | ||||
B7X_OCULTO | 06 | Caracter | 1 | 0 | Func Oculta | Func Oculta | @! | Sim | 0=Não;1=Sim | Sim | Alterar | Real | ||||
B7X_MSGBLO | 07 | Caracter | 70 | 0 | Msg Bloqueio | Msg Bloqueio | @! | Sim | M->B7X_ATIVO == "0" | Sim | Alterar | Real |
Tabela B7Y:
X3_CAMPO | X3_ORDEM | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
B7Y_FILIAL | 01 | Caracter | 8 | 0 | Filial | Filial do Sistema | @! | Não | Não | Visual | Real | |||||
B7Y_CODOPE | 02 | Caracter | 4 | 0 | Codigo Oper | Código Operadora | @! | Sim | PlsIntPad() | Não | Visual | Real | ||||
B7Y_USRID | 03 | Caracter | 3 | 0 | Cod. Usuario | Código Usuário | @! | Sim | GetSx8Num ("B7Y","B7Y_USRID") | Sim | Visual | Real | ||||
B7Y_NOME | 04 | Caracter | 100 | 0 | Nome Usuario | Nome Usuário | @! | Sim | Sim | Alterar | Real | |||||
B7Y_DESCRI | 05 | Caracter | 250 | 0 | Desc Usuario | Descrição do Usuário | @! | Sim | Não | Alterar | Real | |||||
B7Y_STATUS | 06 | Caracter | 1 | 0 | Ativo | Ativo | @! | Sim | "1" | Pertence('01') | 0=Não;1=Sim | Sim | Alterar | Real | ||
B7Y_CLIID | 07 | Caracter | 100 | 0 | Cliente ID | Cliente ID | Sim | P99CGerCli() | Não | Visual | Real | |||||
B7Y_SECRET | 08 | Caracter | 100 | 0 | Secret Key | Secret Key | Sim | P99CKeyGen(.F.) | Não | Visual | Real |
Tabela BJZ:
X3_CAMPO | X3_ORDEM | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BJZ_FILIAL | 01 | Caracter | 8 | 0 | Filial | Filial do Sistema | @! | Não | Não | Visual | Real | |||||
BJZ_CODOPE | 02 | Caracter | 4 | 0 | Codigo Oper | Código Operadora | @! | Sim | PlsIntPad() | Não | Visual | Real | ||||
BJZ_TOKEN | 03 | Caracter | 100 | 0 | Token Gerado | Token Gerado | @! | Sim | Não | Alterar | Real | |||||
BJZ_ATIVO | 04 | Caracter | 1 | 0 | Ativo | Ativo | @! | Sim | 0=Não;1=Sim | Não | Alterar | Real | ||||
BJZ_DATBLO | 05 | Data | 8 | 0 | Data Bloqu | Data Bloqueio | Sim | Não | Alterar | Real | ||||||
BJZ_CLIID | 06 | Caracter | 100 | 0 | Client ID | Client ID | @! | Sim | Não | Alterar | Real | |||||
BJZ_SECRET | 07 | Caracter | 100 | 0 | Secret Key | Secret Key | @! | Sim | Não | Alterar | Real | |||||
BJZ_DTEXPI | 08 | Data | 8 | 0 | Data Expira | Data Expiracao | Sim | Não | Alterar | Real | ||||||
BJZ_HREXPI | 09 | Caracter | 5 | 0 | Hora Expir | Hora Expiracao | @! | Sim | Não | Alterar | Real |
Tabela BJV:
X3_CAMPO | X3_ORDEM | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BJV_FILIAL | 01 | Caracter | 8 | 0 | Filial | Filial do Sistema | @! | Não | Não | Visual | Real | |||||
BJV_CODOPE | 02 | Caracter | 4 | 0 | Codigo Oper | Código Operadora | @! | Sim | PlsIntPad() | Não | Visual | Real | ||||
BJV_LOGIN | 03 | Caracter | 50 | 0 | Login | Login | @! | Sim | Não | Alterar | Real | |||||
BJV_DTVALI | 04 | Data | 8 | 0 | Data Valid | Data Validade | Sim | Não | Alterar | Real | ||||||
BJV_HRVALI | 05 | Caracter | 5 | 0 | Hora Valid | Hora Validade | @! | Sim | Não | Alterar | Real | |||||
BJV_ATIVO | 06 | Caracter | 1 | 0 | Ativo | Ativo | @! | Sim | 0=Não;1=Sim | Não | Alterar | Real | ||||
BJV_CACHE | 07 | Memo | 10 | 0 | Cache | Cache | Sim | Não | Alterar | Real |
Tabela BA0:
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 | X3_FOLDER |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BA0_MSTLOG | Caracter | 1 | 0 | Mobile Login | Mobile Login | @! | Não | '1' | Pertence('12') | 1=CPF;2=Matricula | Não | Alterar | Real | 4 | ||
BA0_MSMULT | Caracter | 1 | 0 | Multicontrat | Mobile Multicontrato | @! | Sim | '1' | Pertence('01') | 0=Não;1=Sim | Não | Alterar | Real | 4 | ||
BA0_MSCACH | Caracter | 1 | 0 | Mobile Cache | Mobile Cache | @! | Sim | '1' | Pertence('01') | 0=Não;1=Sim | Não | Alterar | Real | 4 | ||
BA0_MSCONJ | Caracter | 1 | 0 | Cod Conjuge | Código Cônjuge Mobile | @! | Sim | Não | Alterar | Real | B37PLS | 4 | ||||
BA0_MSCONT | Caracter | 1 | 0 | Contato Tit | Contato Titular | @! | Sim | '0' | Pertence('01') | 0=Não;1=Sim | Não | Alterar | Real | 4 | ||
BA0_MSEND | Caracter | 1 | 0 | Ender Tit | Endereço Titular | @! | Sim | '0' | Pertence('01') | 0=Não;1=Sim | Não | Alterar | Real | 4 | ||
BA0_MSDEPE | Caracter | 1 | 0 | Impr Depend | Imprime Dependentes | @! | Sim | '0' | Pertence('01') | 0=Não;1=Sim | Não | Alterar | Real | 4 | ||
BA0_MSEXPB | Caracter | 1 | 0 | Exc Pag Bloq | Exclui Pagam. Bloqueado | @! | Sim | '1' | Pertence('01') | 0=Não;1=Sim | Alterar | Real | 4 | |||
BA0_MSTPAG | Caracter | 1 | 0 | Exib Tit Pag | Exibe Títulos Pagos | @! | Sim | '1' | Pertence('01') | 0=Não;1=Sim | Alterar | Real | 4 | |||
BA0_MSPDFM | Caracter | 1 | 0 | Modo PDF | Modo PDF | @! | Sim | Pertence('12') | 1=URL;2=Base 64 | Alterar | Real | 4 | ||||
BA0_MSPDFU | Caracter | 254 | 0 | URL PDF | URL PDF | @! | Sim | M->BA0_MSPDFM == '1' | Alterar | Real | 4 | |||||
BA0_MSACES | Caracter | 6 | 0 | Acess Portal | Acess Portal | @! | Sim | Vazio() .Or. ExistCpo("AI3",M->BA0_MSACES) | Alterar | Real | AI3 | 4 | ||||
BA0_MSPERF | Caracter | 6 | 0 | Perf. Acesso | Perf. Acesso | @! | Sim | Vazio() .Or. ExistCpo("B7I",M->BA0_MSPERF) | Alterar | Real | BA0B7I | 4 | ||||
BA0_MSGUIA | Numérico | 2 | 0 | Qt. Meses G. | Quantidade de Meses Guia | 99 | Sim | Não | Alterar | Real | 4 | |||||
BA0_MSDECL | Numérico | 2 | 0 | Qt. Anos Dec | Quantidade Anos Declarac. | 99 | Sim | Não | Alterar | Real | 4 | |||||
BA0_MSDECD | Caracter | 1 | 0 | List. Decla. | Lista de Declaracoes | @! | Sim | 0=Ambas;1=Imposto de Renda;2=Carta de Quitação | Não | Alterar | Real | 4 | ||||
BA0_MSUNDO | Caracter | 254 | 0 | URL Document | URL Documento | @! | Sim | Não | Alterar | Real | 4 | |||||
BA0_MSURST | Caracter | 254 | 0 | URL Status | Endpoint Atualiza Status | @! | Sim | Não | Alterar | Real | 4 |
Tabela BT6:
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BT6_LCVIRT | Caracter | 10 | 0 | Layout Cart | Layout do Cartão | @! | Sim | Não | Alterar | Real |
Tabela BI3:
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BI3_LCVIRT | Caracter | 10 | 0 | Layout Cart | Layout do Cartão | @! | Sim | Não | Alterar | Real |
Tabela BQC:
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BQC_LCVIRT | Caracter | 10 | 0 | Layout Cart | Layout do Cartão | @! | Sim | Não | Alterar | Real |
Tabela BA3:
- Dicionário SX3:
Tabela B7X:
...
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|
BA3_LCVIRT | Caracter |
10 | 0 |
Layout Cart |
Layout do |
Cartão | @! |
Sim | Não |
Alterar | Real |
Tabela BA1:
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BA1_LCVIRT | Caracter | 10 | 0 | Layout Cart | Layout do Cartão | @! | Sim |
Não | Alterar | Real |
Tabela BQL:
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BQL_CODMOB | Caracter | 1 | 0 |
Cod Mobile | Código Mobile | @! | Sim | Vazio() .Or. Pertence('123') | 1=Consignacao / Desconto em folha;2=Boleto;3=Debito em conta | Não | Alterar | Real |
Tabela BG1:
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BG1_LOGIN | Caracter | 1 | 0 | Acao Login | Ação Login | @! | Sim | 1=Permite login;2=Impede login | Não |
Alterar | Real |
Tabela B7YBG3:
...
X3_ |
---|
CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|
BG3_LOGIN | Caracter |
1 | 0 |
Acao Login | Ação Login | @! |
Sim | 1=Permite login;2=Impede login | Não |
Alterar | Real |
Tabela BBA:
X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_DESCRIC | X3_PICTURE | X3_USADO | X3_RELACAO | X3_VALID | X3_CBOX | X3_WHEN | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_F3 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BBA_IDOPER | Numérico | 4 | 0 | Id Operadora | ID da Operadora Integ. | 9999 | Sim | Não | Alterar | Real | |||||
BBA_MSHASH | Caracter | 100 | 0 | Hash | Hash da Solicitação | Sim | Não | Alterar | Real |
- Dicionário SX3:
16. TABELAS UTILIZADAS
- Dicionário SXB:
XB_ALIAS | XB_TIPO | XB_SEQ | XB_COLUNA | XB_DESCRI | XB_CONTEM |
---|---|---|---|---|---|
BA0B7I | 1 | 01 | DB | Perfis de Acesso | B7I |
BA0B7I | 2 | 01 | 01 | Sequencial+Tipo por. | |
BA0B7I | 4 | 01 | 01 | Sequencial | B7I_CODSEQ |
BA0B7I | 4 | 01 | 02 | Descrição | B7I_DESCRI |
BA0B7I | 5 | 01 | B7I_CODSEQ | ||
BA0B7I | 6 | 01 | B7I->B7I_TIPPOR == "3" |
15. IMPLEMENTAÇÃO FUTURA
- Implementação futura1212
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> |