API alerts

01. VISÃO GERAL

A API alerts tem como objetivo trabalhar com ações relacionadas à configurações de alertas no sistema de gestão Plano de Saúde.

VERBO GET

Através do verbo GET, a API pode retornar os dados dos alertas cadastrados (tabela BQ7).

VERBO PUT

Através do verbo PUT, a API permite realizar atualizações dos alertas através da rotina (PLSA777).

02. CONFIGURAÇÕES INI

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:

1. Configuração do REST do Protheus

Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> + /totvsHealthPlans/v1/alerts. Exemplo:

Logo, a minha URL será: http://localhost:8080/rest/totvsHealthPlans/v1/alerts

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo

Path

QueryParams

PathParam

Descrição

GET

alerts

Opcional:

code - Código do alerta (BQ7_CODIGO)

Retorna dados de alertas

PUT

alerts/{id}

id - BQ7_CODIGO

Atualiza dados de um alerta

04. EXEMPLO DE CHAMADA DA API

Chamada GET

http://localhost:8080/rest/totvsHealthPlans/v1/alerts

Exemplo de requisição usando o queryParam code para filtrar o alerta de código 000001.

Caso queira que devolva todos os alertas, é só retirar o queryParam code.

Chamada PUT - Atualizando um alerta

Exemplo atualizando um alerta que tem o BQ7_CODIGO igual a 000001.

http://localhost:8080/rest/totvsHealthPlans/v1/alerts/000001

Exemplo de body:

JSON Solicitação PUT

{
            "code": "000001",
            "description": "Alerta após resposta na mensageria(Auditoria)",
            "sendNotification": "1",
            "txtNotification": "A guia [%B53->B53_NUMGUI%] recebeu uma resposta",
            "titleNotification": "Você tem uma nova mensagem",
            "typeNotification": "1",
            "sendEmail": "1",
            "txtEmail": "<h1 class=\"title\">\r\n                                       Atualização na guia em auditoria\r\n                                    </h1>\r\n                                    <p> Olá, <strong>  [%BAU->BAU_NOME%]!</strong> </p>\r\n                                    <p> Sua guia [%B53->B53_NUMGUI%] recebeu uma nova mensagem! </p>\r\n<div style=\"border: 1px solid black; padding: 10px;\">\r\n        <p>[%cParam%]</p>\r\n    </div>",
            "sendWpp": "0",
            "codeTemplate": "",
            "useLayout": "1"
}

05. ATRIBUTOS DE RESPOSTA

Solicitação GET

Atributo	Campo	Tipo
code	BQ7_CODIGO	Caracter
description	BQ7_DESCRI	Caracter
sendNotification	BQ7_NOTIF	Caracter
txtNotification	BQ7_TXTNOT	Caracter
titleNotification	BQ7_TITNOT	Caracter
typeNotification	BQ7_TIPNOT	Caracter
sendEmail	BQ7_EMAIL	Caracter
txtEmail	BQ7_TXTEMA	Caracter
sendWpp	BQ7_WPP	Caracter
codeTemplate	BQ7_TEMPLA	Caracter
useLayout	BQ7_LAYPAD	Caracter

06. EXEMPLOS DE JSON DE RESPOSTA

Solicitação GET:

Sucesso 202 - Alertas encontrados

{
    "hasNext": false,
    "items": [
        {
            "code": "000001",
            "description": "Alerta após resposta na mensageria(Auditoria)",
            "sendNotification": "1",
            "txtNotification": "A guia [%B53->B53_NUMGUI%] recebeu uma resposta",
            "titleNotification": "Você tem uma nova mensagem",
            "typeNotification": "1",
            "sendEmail": "1",
            "txtEmail": "<h1 class=\"title\">\r\n                                       Atualização na guia em auditoria\r\n                                    </h1>\r\n                                    <p> Olá, <strong>  [%BAU->BAU_NOME%]!</strong> </p>\r\n                                    <p> Sua guia [%B53->B53_NUMGUI%] recebeu uma nova mensagem! </p>\r\n<div style=\"border: 1px solid black; padding: 10px;\">\r\n        <p>[%cParam%]</p>\r\n    </div>",
            "sendWpp": "0",
            "codeTemplate": "",
            "useLayout": "1"
        },
        {
            "code": "000002",
            "description": "Alerta após resposta na mensageria(Faturamento)",
            "sendNotification": "1",
            "txtNotification": "O protocolo [%BCI->BCI_CODPEG%] recebeu uma resposta.",
            "titleNotification": "Você tem uma nova mensagem",
            "typeNotification": "1",
            "sendEmail": "1",
            "txtEmail": "<h1 class=\"title\">\r\n                                       Atualização no protocolo de faturamento\r\n                                    </h1>\r\n                                    <p> Olá, <strong>  [%BCI->BCI_NOMRDA%]!</strong> </p>\r\n                                    <p> Seu protocolo [%BCI->BCI_CODPEG%] recebeu uma nova mensagem! </p>\r\n<div style=\"border: 1px solid black; padding: 10px;\">\r\n        <p>[%cParam%]</p>\r\n    </div>",
            "sendWpp": "0",
            "codeTemplate": "",
            "useLayout": "1"
        }
    ]
}

Solicitação PUT - Alteração de Alertas

Falha - HTTP Status 400

Falha - Alerta não encontrado

{
    "code": "0002",
    "message": "Erro ao atualizar registro!",
    "detailedMessage": "Não foi possível fazer a atualização, tente novamente mais tarde"
}

Árvore de páginas