Histórico da Página
CONTEÚDO
- Visão Geral
- Configurações INI
- Verbos
- Uso da API - PUT
- Atributos de Resposta
01. VISÃO GERAL
A API chat tem como objetivo, oferecer opções de manutenção da mensageria/chat entre o Sistema de Gestão Plano de Saúde (SIGAPLS) e o Portal Autorizador HAT. Esta API realiza manutenção nos controles das tabelas do Plano de Saúde relacionadas a esse tema.
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:
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | URL | Descrição |
---|---|---|
PUT | https://<url>:porta>/rest/totvsHealthPlans/v1/chat/:id/auditing | Realiza a alteração de valores de controle do chat no nível de Auditoria (Tabela B53). Informar o número da guia no pathparam id. |
04. USO DA API - PUT
Para atualizar o status da sala de Mensageria:
No header, é obrigatório o envio das chaves:
Chave | Valor |
---|---|
x-erp-module | 33 |
x-totvs-app | PLS |
authorization | BASIC <usuário:senha em BASE 64> (Enviar somente se a API do PLS solicitar autenticação) |
Dados do payload de envio:
Atributo | Tipo | Descrição |
---|---|---|
chatStatus | Caracter | Status de sala de chat. Opções: 1=Pend. Auditor 2=Pend. Prestador 3=Finalizado |
Bloco de código | ||
---|---|---|
| ||
{ "chatStatus" : "1" } |
05. ATRIBUTOS DE RESPOSTA
Quando houver sucesso na alteração do registro, a API retorna um status 202.
Caso seja apresentado um erro, será retornado o status 400 com o seguinte JSON de resposta:
Bloco de código | ||
---|---|---|
| ||
{ "code": 400, "message": "Guia informada nao encontrada", "detailedMessage": "Nao foi encontrada a guia informada no alias B53" } |