Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. Configurações INI
  3. 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
  4. API Primeiro Acesso - createUsernovoUsuario
  5. API Login Beneficiário - authlogin
  6. API Lembrar Reiniciar Senha - rememberPassreiniciarSenha
  7. API Trocar Senha - changePasstrocarSenha
  8. API Extrato de Utilização - extrato
  9. API Lista Débitos - listaDebitos
  10. API Detalhe Débito - detalheDebito
  11. API Boleto PDF - boletoPdf
  12. API Extrato Fatura PDF - extratoFaturaPdf
  13. Menus
  14. Tabelas Utilizadas

...

Importante: todas as APIs são comunicadas com o verbo Post.


04. API PRIMEIRO ACESSO -

...

novoUsuario


URLhttps://<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ávelTipoObrigatórioDescrição
cCodigoCaracterSimCódigo do registro BSW criado
Retorno
VariávelTipoObrigatórioDescrição
Não há retorno



05. API LOGIN BENEFICIÁRIO -

...

login


URLhttps://<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ávelTipoObrigatórioDescrição
oBeneficiaryJSON ObjectSimObjeto JSON montado pelo sistema
Retorno
VariávelTipoObrigatórioDescrição
cRedeAtendCaracterNãoMensagem que será apresentada no atributo redeAtendimento.



06. API

...

REINICIAR SENHA -

...

reiniciarSenha


URLhttps://<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.

...

Bloco de código
titleExemplo do json com a nova senha
linenumberstrue
collapsetrue
{
    "senha": "148572",
    "alerta": " ",
    "status": true,
    "telefone": " ",
    "enviado": false,
    "email": "[email protected]",
    "login": "95191329023"
}


07. API TROCAR SENHA -

...

trocarSenha


URLhttps://<url>:<porta>/rest/mobileSaude/v1/changePasstrocarSenha

Esta API é responsável pela troca de senha dos beneficiários que utilizam o aplicativo.

...

URLhttps://<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
titleExemplo do json de solicitação do extrato de utilização
linenumberstrue
collapsetrue
{
	"chaveBeneficiarioTipo": "CPF",
	"matriculaVida": "00000004",
	"multiContract": true,
	"chaveBeneficiario": "44046668458",
	"tipoUsuario" : "T",
	"idPeriodo" : "202006",
	"ano" : "2020",
	"mes" : "06"
}

...