Histórico da Página

...

Visão Geral
Configurações INI
Configurações Remote
1. Cadastro de Usuários API
2. Cadastro de Funcionalidades
3. Cadastro de Operadoras
4. Cadastro de Bloqueios BG1 e BG3
5. Cadastro de Layouts do Cartão
6. Cadastro Formas de Pagamento
API Primeiro Acesso - createUsernovoUsuario
API Login Beneficiário - authlogin
API Lembrar Reiniciar Senha - rememberPassreiniciarSenha
API Trocar Senha - changePasstrocarSenha
API Extrato de Utilização - exUtilizacaoAPI Extrato de Co-Participação - exCoparticipacaoextrato
API Lista Débitos - listaDebitos
API Detalhe Débito - detalheDebito
API Boleto PDF - boletoPdf
API Extrato Fatura PDF - extratoFaturaPdfAPI 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

...

exCoparticipacao

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

...

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

title	Exemplo

Bloco de código

title	Exemplo do json solicitando lembrar a senha
linenumbers	true
collapse	true

{
  "cpflogin": "9519132902363369527030",
  "dataNascimento": "19581985-11-0506-17",
  "senha": "12345678",
  "email": "[email protected]"
}

Bloco de código

title	Exemplo do json com a nova senha
linenumbers	true
collapse	true

{
    "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>/restURL - 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

title	Exemplo do json confirmando a troca de senha
linenumbers	true
collapse	true

{
    "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

title	Exemplo do json de solicitação do extrato de utilização
linenumbers	true
collapse	true

{
	"chaveBeneficiarioTipo": "CPF",
	"matriculaVida": "00000004",
	"multiContract": true,
	"chaveBeneficiario": "44046668458",
	"tipoUsuario" : "T",
	"idPeriodo" : "202006",
	"ano" : "2020",
	"mes" : "06"
}

Bloco de código

title	Exemplo do json de retorno com o extrato de utilização
linenumbers	true
collapse	true

{
    "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

title	Exemplo do json de solicitação do extrato de co-participação
linenumbers	true
collapse	true

{
	"chaveBeneficiarioTipo": "CPF",
	"matriculaVida": "00000004",
	"multiContract": true,
	"chaveBeneficiario": "44046668458",
	"tipoUsuario" : "T",
	"idPeriodo" : "202006",
	"ano" : "2020",
	"mes" : "06"
}

Bloco de código

title	Exemplo do json de retorno com o extrato de co-participação
linenumbers	true
collapse	true

{
    "status": true"valorCoparticipacao": "22.92",
            "valorServico": "77.12",
            "nomeExecutante": "HOSPITAL BOM CLIMA",
    "extrato": [
        {"quantidade": "1.00",
            "valorCoparticipacaocodigoContrato": "0.2100010004000002",
            "valorServiconomeBeneficiario": "0.69AMANDA BARBARA",
            "nomeExecutantecodigoEvento": "HOSPITAL BOM CLIMA10101012",
            "quantidadedescricaoEvento": "1.00CONSULTA EM CONSULTORIO",
            "codigoContratodataAtendimento": "000100040000022020-06-09",
            "nomeBeneficiariocodigoExecutante": "AMANDA BARBARA000004",
            "codigoEventocpfCnpjExecutante": "40303136"34585221000190,
            "descricaoEventocodigoTipoServico": "SANGUE OCULTO, PESQUISA NAS FEZES000001",
            "dataAtendimentodescricaoTipoServico": "2020-06-08CONSULTAS",
            "codigoExecutantematriculaBeneficiario": "00000400010004000002000",
        },
        {
			"cpfCnpjExecutantevalorCoparticipacao": 34585221000190"0.00",
            "codigoTipoServicovalorServico": "0000022.42",
            "descricaoTipoServiconomeExecutante": "EXAMESHOSPITAL EBOM TERAPIASCLIMA",
            "matriculaBeneficiarioquantidade": "000100040000020001.00",
        },
        {"codigoContrato": "00010004000002",
            "valorCoparticipacaonomeBeneficiario": "22.92AMANDA BARBARA",
            "valorServicocodigoEvento": "77.1210106014",
            "nomeExecutantedescricaoEvento": "HOSPITALACONSELHAMENTO BOM CLIMAGENETICO",
            "quantidadedataAtendimento": "1.002020-06-11",
            "codigoContratocodigoExecutante": "00010004000002000004",
            "nomeBeneficiariocpfCnpjExecutante": "AMANDA BARBARA"34585221000190,
            "codigoEventocodigoTipoServico": "10101012000001",
            "descricaoEventodescricaoTipoServico": "CONSULTA EM CONSULTORIOCONSULTAS",
            "dataAtendimentomatriculaBeneficiario": "2020-06-0900010004000002000",
            "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 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

title	Exemplo do json de solicitação de débitos
linenumbers	true
collapse	true

{
    "tipoUsuario": "T",
    "chaveBeneficiarioTipo": "CPF",
    "matriculaVida": "00000005",
    "multiContract": true,
    "chaveBeneficiario": "44046668458"
}

Bloco de código

title	Exemplo do json com os títulos SE1
linenumbers	true
collapse	true

{
    "status": true,
    "debitos": [
         "valorCoparticipacao": "0.72", {
            "valorServicodescricao": "2.42",
            "nomeExecutantevalor": "HOSPITAL BOM CLIMA"4866,
            "quantidadetituloId": "1.00"6320,
            "codigoContratotituloCodigo": "00010004000002PLS|000000039| |DP ",
            "nomeBeneficiariocodigoContrato": "AMANDA BARBARA00010004000002",
            "codigoEventotipoCobranca": "10106014D",
            "descricaoEventodataEmissao": "ACONSELHAMENTO GENETICO2020-06-10",
            "dataAtendimentodataVencimento": "2020-06-1110",
            "codigoExecutantesituacao": "000004A",
        },
     "cpfCnpjExecutante   {
            "descricao": 34585221000190"",
            "codigoTipoServicovalor": 216,
            "000001tituloId": 6364,
            "descricaoTipoServicotituloCodigo": "CONSULTASPLS|000000081| |DP ",
            "matriculaBeneficiariocodigoContrato": "0001000400000200000010004000002",
             }
"tipoCobranca": "D",
             ]
}"dataEmissao": "2020-08-28",
            "dataVencimento": "2020-08-28",
            "situacao": "A"
        }
    ]
}

Importante: o campos Exib Tit Pag (BA0_MSTPAG) afeta 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 retorna todos os títulos financeiros (tabela SE1) relacionados ao usuário selecionado.

Bloco de código

title	Exemplo do json de solicitação de débitos
linenumbers	true
collapse	true

{
    "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 B = Boleto D = Débito em conta

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) A = Atrasado (em aberto, porém já vencido) B = Baixado (já foi pago)

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

title	Exemplo do json de solicitação de detalhe de um débito
linenumbers	true
collapse	true

{
    "tituloId": 6353,
    "tituloCodigo": "PLS|000000071| |DP "
}

Bloco de código

title	Exemplo do json de resposta com os detalhes de um débito
linenumbers	true
collapse	true

{
    "status": true,
    "detalhes": [
        {

Bloco de código

title	Exemplo do json com os títulos SE1
linenumbers	true
collapse	true

{
    "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,
            "tituloCodigosituacao": "PLS|000000081| |DP A",
            "codigoContratovalor": 578,
            "00010004000002valorAtualizado": [],
            "tipoCobrancatextoConfirmacao": "D",
            "dataEmissaodataVencimento": "2020-0806-2810",
            "dataVencimentoimprimeBoleto": "2020-08-28N",
            "situacaotipoCobranca": "AD",
             }
    ]
}

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

Variável

Parâmetro	Tipo	Obrigatório	Descrição

cFormRec

cPrefixo

Caracter

SimForma de Recebimento definido no campo E1_FORMREC

Não	Prefixo do título
cNumero	Caracter

nTituloIdNumérico

Não

Recno

Número do

registro SE1

título

Retorno

cParcela

Variável

Caracter

Tipo

Não

ObrigatórioDescriçãocTipoCobranca

Parcela do título
cTipo	Caracter

Sim

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)

Retorno
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
Parâmetro

O ponto de entrada PMOBFI04 permite alterar a query que será processsada ao realizar a busca dos títulos SE1:

Ponto de Entrada: PMOBFI04Fonte: PMobFinModParâmetrosVariável

	Tipo	Obrigatório	Descrição

cSql

cCodbar

Caracter

Sim

Query padrão do sistemalMultiContractBooleanSimIndica o MultiContrato está habilitadolLoginByCPFBooleanSimIndica se é login por CPFcChaveBeneficiarioCaracterSimChave do beneficiário enviado no JSON de solicitação.RetornoVariávelTipoObrigatórioDescriçãocSqlCaracterSim

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

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

title	Exemplo do json de solicitação de detalhe de um débitoboleto PDF
linenumbers	true
collapse	true

{
    "tituloId": 6353,
    "tituloCodigo": "PLS|000000071| |DP "
}

Bloco de código

title	Exemplo do json de resposta com os detalhes de um débitoretorno com a URL para baixar o PDF de Boleto
linenumbers	true
collapse	true

{
    "status": true,
    "detalhesurl": [
        {
            "situacao": "A",
        "http://spon019400235:87/pp/imagens-pls/relatorios/boletosc006450.pdf",
    "valorbase64": 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 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

title	Exemplo do json de solicitação de boleto PDF
linenumbers	true
collapse	true

{
    "tituloId": 6353,
    "tituloCodigo": "PLS|000000071| |DP "
}

Bloco de código

title	Exemplo do json de retorno com a URL para baixar o PDF de Boleto
linenumbers	true
collapse	true

{
    "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

title	Exemplo do json de solicitação de extrato PDF
linenumbers	true
collapse	true

{
	"tituloId": 6353,
     "tituloCodigo": "PLS|000000071| |DP "
}

Bloco de código

title	Exemplo do json de retorno com a URL para baixar o PDF de Extrato
linenumbers	true
collapse	true

{
    "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

title	Exemplo do json retornando a Composição de Cobrança
linenumbers	true
collapse	true

{
	"tituloId": 6353,
    "tituloCodigo": "PLS|000000071| |DP "
}

Bloco de código

title	Exemplo do json de resposta com a Composição da Cobrança
linenumbers	true
collapse	true

{
    "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"
        }
    ]
}

...

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

title	Exemplo do json de solicitação de extrato PDF
linenumbers	true
collapse	true

{
	"tituloId": 6353,
     "tituloCodigo": "PLS|000000071| |DP "
}

Bloco de código

title	Exemplo do json de retorno com a URL para baixar o PDF de Extrato
linenumbers	true
collapse	true

{
    "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

...

LOGINCaracter50@! Sim

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		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	BJV_FILIAL	01	Caracter	8	0	Filial	Filial do Sistema	@!	NãoSim					Não	VisualAlterar	Real
BJV_CODOPEATIVO	0206	Caracter	41	0	Codigo OperAtivo	Código OperadoraAtivo	@!	SimPlsIntPad()			0=Não;1=Sim		Não	VisualAlterar	Real
BJV_	CACHE	0307	Memo	10	0	Login	Login	Cache	Cache		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	@!

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

BJV

BA0_

ATIVO06

MSMULT

Caracter

1

0

Ativo

Multicontrat

Ativo

Mobile Multicontrato

@!

Sim

'1'

Pertence('01')

0=Não;1=Sim

Não

Alterar

Real

4

BJV

BA0_

CACHE

MSCACH

07

Caracter

Memo10

1

0

Mobile Cache

@!

Sim

'1'

Pertence('01')

0=Não;1=Sim

Não

Alterar

Real

4

...

BA0

...

X3

_

CAMPOX3_TIPOX3_TAMANHOX3_DECIMALX3_TITULOX3_DESCRICX3_PICTUREX3_USADOX3_RELACAOX3_VALIDX3_CBOXX3_WHENX3_BROWSEX3_VISUALX3_CONTEXTX3_F3

MSCONJ

Caracter

1

0

Cod Conjuge

Código Cônjuge Mobile

@!

Sim

Não

Alterar

Real

B37PLS

4

BA0_MSCONT

BA0_MSTLOG

Caracter

1

0

Mobile Login

Contato Tit

Contato Titular

Mobile Login

@!

Não

Sim

'

1

0'	Pertence('

12

01')

1

0=

CPF

Não;

2

1=

Matricula

Sim		Não	Alterar	Real		4
BA0_

MSMULT

MSEND

Caracter

1

0

Multicontrat

Ender Tit

Endereço Titular

Mobile Multicontrato

@!

Sim

'

1

0'	Pertence('01')	0=Não;1=Sim		Não	Alterar	Real		4
BA0_

MSCACH

MSDEPE

Caracter

1

0

Mobile Cache

Impr Depend

Imprime Dependentes

Mobile Cache

@!

Sim

'

1

0'	Pertence('01')	0=Não;1=Sim		Não	Alterar	Real		4
BA0_

MSCONJ

MSEXPB

Caracter

1

0

Cod Conjuge

Exc Pag Bloq

Exclui Pagam. Bloqueado

Código Cônjuge MobileNão

@!

Sim

'1'

Pertence('01')

Sim

0=Não;1=Sim

Alterar

Real

B37PLS

	4
BA0_

MSCONT

MSTPAG

Caracter

1

0

Contato

Exib Tit Pag

Contato Titular

Exibe Títulos Pagos

@!

Sim

'

0

1'

Pertence('01')

0=Não;1=Sim

Não

			Alterar	Real		4
BA0_

MSEND

MSPDFM

Caracter

1

0

Ender Tit

Modo PDF

Endereço Titular

@!

Sim

'0'

Pertence('

01

12')

0

1=

Não

URL;

1=SimNão

2=Base 64			Alterar	Real		4
BA0_

MSDEPE

MSPDFU

Caracter

1

254

0

Impr Depend

URL PDF

Imprime Dependentes

@!

Sim

M->BA0_MSPDFM == '1'

0'Pertence('01')0=Não;1=SimNãoAlterarReal

Alterar

Real

4

BA0_MSACES

Caracter

6

0

Acess Portal

@!

Sim

Vazio() .Or. ExistCpo("AI3",M->BA0_MSACES)

Alterar

Real

AI3

4

BA0_MSPERF

Caracter

6

0

Perf. Acesso

BA0_MSEXPBCaracter10Exc Pag BloqExclui Pagam. Bloqueado0=Não;1=Sim

@!

Sim

'1'Pertence('01')

Vazio() .Or. ExistCpo("B7I",M->BA0_MSPERF)				Alterar	Real	BA0B7I	4
BA0_

MSTPAG

MSGUIA

Caracter

Numérico

1

2

0

Exib Tit PagExibe Títulos Pagos@! Sim'1'Pertence('01')

Qt. Meses G.

Quantidade de Meses Guia

99

Sim

Não

0=Não;1=Sim

	Alterar	Real		4
BA0_

MSPDFM

MSDECL

Caracter

Numérico

1

2

0

Modo PDFModo PDF@! SimPertence('12')

Qt. Anos Dec

Quantidade Anos Declarac.

99

Sim

Não

1=URL;2=Base 64

	Alterar	Real		4
BA0_

MSPDFU

MSDECD

Caracter

100

1

0

URL PDF

List. Decla.

Lista de Declaracoes

URL PDF

@!

Sim

M->BA0_MSPDFM == '1'

		0=Ambas;1=Imposto de Renda;2=Carta de Quitação		Não	Alterar	Real		4
BA0_

MSACES

MSUNDO

Caracter

6

254

0

Acess Portal

URL Document

URL Documento

Acess Portal

@!

Sim

Vazio() .Or. ExistCpo("AI3",M->BA0_MSACES)

Não

Alterar

Real

AI3

	4
BA0_

MSPERF

MSURST

Caracter

6

254

0

Perf. Acesso

URL Status

Endpoint Atualiza Status

Perf. Acesso

@!

Sim

Vazio() .Or. ExistCpo("B7I",M->BA0_MSPERF)

Não

Alterar

Real

BA0B7I

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

...

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 BQCBQL:

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	101	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

...

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 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 futura

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>

Árvore de páginas

Versões comparadas

Versão antiga 51

Nova versão Atual

Chave

01. VISÃO GERAL

04. API PRIMEIRO ACESSO -

novoUsuario

06. API

REINICIAR SENHA -

reiniciarSenha

07. API TROCAR SENHA - changePass

07. API TROCAR SENHA - trocarSenha

08. API EXTRATO DE UTILIZAÇÃO -

extrato

09. API EXTRATO DE CO-PARTICIPAÇÃO - exCoparticipacao

09. API LISTA DÉBITOS - listaDebitos

10. API LISTA DÉBITOS - listaDebitos

10. API DETALHE DÉBITO - detalheDebito

11. API BOLETO PDF - boletoPdf

11. API DETALHE DÉBITO - detalheDebito

12. API BOLETO PDF - boletoPdf

13. API EXTRATO FATURA PDF - extratoFaturaPdf

14. API COMPOSIÇÃO COBRANÇA - composicaoCobranca

12. API EXTRATO FATURA PDF - extratoFaturaPdf

13. MENUS

14. TABELAS UTILIZADAS

15. IMPLEMENTAÇÃO FUTURA

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 51

Nova versão Atual

Chave

01. VISÃO GERAL

04. API PRIMEIRO ACESSO -

novoUsuario

05. API LOGIN BENEFICIÁRIO -

login

06. API

REINICIAR SENHA -

reiniciarSenha

07. API TROCAR SENHA - changePass

07. API TROCAR SENHA - trocarSenha

08. API EXTRATO DE UTILIZAÇÃO -

extrato

09. API EXTRATO DE CO-PARTICIPAÇÃO - exCoparticipacao

09. API LISTA DÉBITOS - listaDebitos

10. API LISTA DÉBITOS - listaDebitos

10. API DETALHE DÉBITO - detalheDebito

11. API BOLETO PDF - boletoPdf

11. API DETALHE DÉBITO - detalheDebito

12. API BOLETO PDF - boletoPdf

13. API EXTRATO FATURA PDF - extratoFaturaPdf

14. API COMPOSIÇÃO COBRANÇA - composicaoCobranca

12. API EXTRATO FATURA PDF - extratoFaturaPdf

13. MENUS

14. TABELAS UTILIZADAS

15. IMPLEMENTAÇÃO FUTURA