Histórico da Página

CONTEÚDO

Visão Geral
Configurações INIAPI
Verbos
Path Param
Exemplos de Jsons de Resposta

01. VISÃO GERAL

A API

...

auditCarolPos tem como objetivo

...

fornecer o histórico completo das ações realizadas pelos auditores. Ela registra detalhadamente quais ações foram executadas, por qual auditor, em quais lotes, qual o prestador relacionado, e em qual data e hora.

A API retorna: código do prestador executante na operadora, número do protocolo, número do lote. número da guia do prestador, nome do auditor, email do auditor, data da audição, hora da audição, ação que está sendo tomada pelo auditor e descrição dessa ação (por ex: aprovou o item 123, negou o item 123, iniciou a análise, finalizou a análise).

A API está no ambiente de produção, portanto, a requisição deve apontar para o mesmo.

A URL da requisição será:

    https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPos? + parâmetros de busca (especificados na seção abaixo)

02. CONFIGURAÇÕES API

Seguem as configurações que devem ser feitas na plataforma da API antes da requisição.

Selecionar o Método de GET
Configurar sua autenticação para requisição
1. Na aba HEADERS:
  Key Value
  Authorization Valor presente no parâmetro MV_PHATNMT no PLS
  tenantName Valor presente no parâmetro MV_PHATQTD no PLS
  idTenant Valor presente no parâmetro MV_PHATTOK no PLS
  O token de Authorization deve ser o Master Token, para não expirar.
  [ MASTER TOKEN - GERANDO E CONFIGURANDO ]
  
  3.4 - Configurar Chave de Autenticação das Integrações (Master Token) e Dados de integração

03. VERBOS

Esta API utiliza função padrão do produto para processamento da requisição. <AQUI>Função principal - PLVLDUSRP e função auxiliar - PLSA090USR.<AQUI>

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: Configuração do REST Protheus

Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> + /api//healthcare/hatfaturamento/v1/auditCarolPos

Exemplo:

Image Removed

Port: Sua porta local (localhost) do REST para rodar a API

URL (em HTTPURI): Complemento e nome da api que vai ser utilizada, neste caso /api/healthcare

ENVIRONMENT: Ambiente de execução

Logo, a minha URL será: http://localhost:5000/api/healthcare/hatfaturamento/v1/auditCarolPos?dateFrom={dateFrom}&dateTo={dateTo}

03. VERBOS

...

Seguem os verbos disponíveis na API:
Verbo
Path
Descrição
GET /auditCarolPos
<AQUI>Elegibilidade do Beneficiário<AQUI>
auditCarolPos é o nome da API, e deve ser colocado logo após a URL e seu complemento indicativo que a API é do HAT:
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPos

04.PATH PARAMS - GET

Lista de query params OBRIGATÓRIOS:

Parâmetro na API	Campo	Descrição
dateFrom	Data De

<AQUI>

De qual até qual o período que você deseja buscar os detalhes da auditoria.
dateTo	Data Até

<AQUI>

De qual Até qual o período que você deseja buscar os detalhes da auditoria.

https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPos?dateFrom=2025-05-01&dateTo=2025-09-01

Aqui vão ser retornados os registros que estão entre as datas 01/05/2025 e 01/09/2025

As datas devem ser passadas no formato: AAAA-MM-DD.s

Caso não forem passadas as duas data, a API retornará um BadRequest 400 acompanhado de uma mensagem de que é necessário informar ambos os parâmetros.

Lista de query params OPCIONAIS:

Parâmetro na API	Campo	Descrição
healthProviderId	Código Prestador (RDA)<AQUI>	Código do Prestador Executante da Operadora
auditorEmail	<AQUI>	Email do Auditor	Email do Auditor<AQUI>
batch	Número Lote	<AQUI>
page
pageSize

<AQUI>Exemplo de chamada para utilização de um beneficiário em Dezembro de 2017:<AQUI>localhost:4202uso:

https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPos?dateFrom=2025-

...

05-01&dateTo=2025-09-

...

01&healthProviderId=000005&[email protected]&batch=298374&page=1&pageSize=50

As datas devem ser passadas no formato: AAAA-MM-DD

05. EXEMPLOS DE JSONS DE RESPOSTA

Sucesso 200

Image Removed

{
"items": [
{
"healthProviderId": "000005",
"idOnHealthInsurer": "1499959",
"protocol": "00029010",
"batch": "3539",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:32:20",
"action": "4",
"actionDescription": "Analise salva"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "1499959",
"protocol": "00029010",
"batch": "3539",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:32:00",
"action": "2",
"actionDescription": "Negou o item 0029-18-60004746"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "1499959",
"protocol": "00029010",
"batch": "3539",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:30:57",
"action": "1",
"actionDescription": "Iniciou a analise"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "528731",
"protocol": "00029149",
"batch": "3214",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:22:28",
"action": "5",
"actionDescription": "Analise finalizada"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "528731",
"protocol": "00029149",
"batch": "3214",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:22:20",
"action": "2",
"actionDescription": "Adicionou o item 0005-22-10101012"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "528731",
"protocol": "00029149",
"batch": "3214",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:22:17",
"action": "2",
"actionDescription": "Adicionou o item 0004-00-10101013"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "528731",
"protocol": "00029149",
"batch": "3214",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:22:12",
"action": "2",
"actionDescription": "Aprovou o item 0001-22-10101039"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "528731",
"protocol": "00029149",
"batch": "3214",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:22:10",
"action": "2",
"actionDescription": "Negou o item 0002-22-10101012"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "528731",
"protocol": "00029149",
"batch": "3214",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:22:06",
"action": "2",
"actionDescription": "Negou o item 0003-00-10101013"
},
{
"healthProviderId": "000005",
"idOnHealthInsurer": "528731",
"protocol": "00029149",
"batch": "3214",
"name": "isDevMode",
"auditorEmail": "isDevMode@carol.com.br",
"TransactionDate": "12/03/2025",
"transactionTime": "15:21:48",
"action": "1",
"actionDescription": "Iniciou a analise"
}
],
"hasNext": false,
"message": ""
}

A API retorna todos os campos da tabela LogCarolPos

Erro 400 Image RemovedBad Request

1
2
3
4

{
"items": [ ],
"hasNext": false,
"message": "Necessario informar os campos 'dateFrom' e 'dateTo'"
}

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

CONTEÚDO

01. VISÃO GERAL

02. CONFIGURAÇÕES API

03. VERBOS

02. CONFIGURAÇÕES INI

03. VERBOS

04.PATH PARAMS - GET

05. EXEMPLOS DE JSONS DE RESPOSTA

Key	Value
Authorization	Valor presente no parâmetro MV_PHATNMT no PLS
tenantName	Valor presente no parâmetro MV_PHATQTD no PLS
idTenant	Valor presente no parâmetro MV_PHATTOK no PLS