A API notification tem como objetivo retornar notícias cadastradas para beneficiários e também incluir o histórico de visualização. Os verbos disponibilizados são o GET e o POST.
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:
Seguem os verbos disponíveis na API:
Verbo | URL | Descrição |
|---|---|---|
| GET | https://<url>:porta>/rest/totvsHealthPlans/v1/notification | Retorna as notícias para o beneficiário informado e quais foram já foram visualizadas ou não visualizadas. |
| POST | https://<url>:porta>/rest/totvsHealthPlans/v1/notification | Registra o histórico de visualizações da notícia. |
GET
Dados do queryparam de envio:
Atributo | Tipo | Regra | Descrição |
|---|---|---|---|
| codeUser | Caracter | Obrigatório | BSW_CODUSR |
POST
Dados do body de envio:
Atributo | Tipo | Regra | Descrição |
|---|---|---|---|
| codeNotification | Caracter | Obrigatório | BPL_CODIGO |
codeUser | Caracter | Obrigatório | BSW_CODUSR |
API GET - JSON de resposta:
Atributo | Campo Protheus |
|---|---|
code | BPL_CODIGO |
title | BPL_TITULO |
message | BPL_NOTICI |
visualized | Se tiver registro para BPL_CODIGO + BSW_CODUSR na tabela BJH será enviado true, caso contrário, false. |
API POST - JSON de resposta:
Atributo pai | Atributo | Campo Protheus |
|---|---|---|
loginDetails | code | BSW_CODUSR |
username | BSW_LOGUSR | |
BSW_EMAIL | ||
name | BSW_NOMUSR | |
beneficiaries | subscriberId | B49_BENEFI |
name | BA1_NOMUSR | |
subscriberType | BA1_TIPUSU | |
menus | code | AI8_CODMNU |
name | AI8_TEXTO | |
main | AI8_CODPAI | |
module | AI8_ROTINA |
BSW - Login
BPL - Cadastro de Noticias
BJH - Notificações Lidas