Árvore de páginas

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 2 Próxima »


CONTEÚDO

  1. Visão Geral
  2. Configurações INI
  3. Verbos
  4. Path Param
  5. Exemplos de Jsons de Resposta


01. VISÃO GERAL

A API AuditCarolPos tem como objetivo retornar dados do <AQUI>beneficiário e seu titular, conforme solicitação que pode ser por CPF, MATRICULA ou MATRICULA ANTIGA.<AQUI> 

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:

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

<AQUI>

Seguem os verbos disponíveis na API:

Verbo

Path

Descrição

GET/auditCarolPos<AQUI>Elegibilidade do Beneficiário<AQUI>

04. PATH PARAMS - GET

Lista de query params OBRIGATÓRIOS:

Parâmetro na API

Campo

Descrição

dateFromData De<AQUI>
dateToData Até<AQUI>
Parâmetro na APICampoDescrição
healthProviderIdCódigo Prestador (RDA)<AQUI>
auditorEmail<AQUI><AQUI>
batchNúmero Lote<AQUI>

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

localhost:4202/api/healthcare/hatfaturamento/v1/auditCarolPos?dateFrom=2025-01-01&dateTo=2025-09-04


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


05. EXEMPLOS DE JSONS DE RESPOSTA


Sucesso 200


{
    "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

1
2
3
4

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

  • Sem rótulos