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 - extrato
- API Lista Débitos - listaDebitos
- API Detalhe Débito - detalheDebito
- API Boleto PDF - boletoPdf
- API Extrato Fatura PDF - extratoFaturaPdf
- Menus
- Tabelas Utilizadas
...
- 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 | extratoFaturaPDFextratoFaturaPdf |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "cpflogin": "9519132902363369527030", "dataNascimento": "19581985-1106-0517" } | ||||||
Bloco de código | ||||||
,
"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 -
...
trocarSenha
URL - https://<url>:<porta>/rest/mobileSaude/v1/changePasstrocarSenha
Esta API é responsável pela troca de senha dos beneficiários que utilizam o aplicativo.
...
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 | ||||||
---|---|---|---|---|---|---|
Bloco de código | ||||||
| ||||||
{ "chaveBeneficiarioTipo": "CPF", "matriculaVida": "00000004", "multiContract": true, "chaveBeneficiario": "44046668458", "tipoUsuario" : "T", "idPeriodo" : "202006", "ano" : "2020", "mes" : "06" } |
...
Importante: O atributo linhaDigitavel é obrigatório e deve ser gerado através do ponto de entrada PMOBFI03:
...
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.
...
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 |
...
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" |
...