Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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/procedures. Exemplo:

image2020-12-17_15-28-30.png

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


03. VERBOS

Seguem os verbos disponíveis na API: 

...

VerboPathPath ParamDescrição
GETprocedures
Busca por filtro complexo
GETproceduresprocedureId (código do procedimento)Busca por código de procedimento


04. EXEMPLOS DE CHAMADA DA API

Chamada por filtro complexo:

Para o funcionamento correto da API, informar os QueryParams:

QueryParamObrigatórioDescrição
actionSimInformar sempre typeAhead
pageSizeSimQuantidade de registros que serão apresentados em uma solicitação (o padrão é 7).
filterSim se tableCode não informado

Filtro que será realizado na API. O padrão do filtro é:

( Filtro de Tabelas ) and filtro de Código de Procedimento or filtro de Código de Descrição.

Seguir o modelo abaixo (filtrando CONSULTA como exemplo):

(tableCode eq '18' or tableCode eq '19' or tableCode eq '20' or tableCode eq '22' or tableCode eq '00' or tableCode eq '98') and  procedureId startswith('CONSULTA') or procedureDescription startswith('CONSULTA')

Importante: utilizar %20 para espaços e %27 para aspas simples.

procedureIdSimCódigo do procedimento buscado.
tableCodeSim se filter não informado

Código da tabela de terminologia TISS. Utilize:

00 Tabela própria das operadoras
18 Diárias, taxas e gases medicinais
19 Materiais e Órteses, Próteses e Materiais Especiais (OPME)
20 Medicamentos
22 Procedimentos e eventos em saúde
90 Tabela Própria Pacote Odontológico
98 Tabela Própria de Pacotes

customWhereNão

Realiza um filtro adicional:

1 - Consultas

9 - Procedimentos de Odonto

tratSeriado - Eventos de Seriado (Definidos pela classe do evento BJE_TIPO = 2)

Exemplo da chamada filtrando por filter: http://localhost:8080/rest/totvshealthplans/v1/procedures?action=typeAhead&pageSize=7&customWhere=1&filter=(tableCode%20eq%20%2718%27%20or%20tableCode%20eq%20%2719%27%20or%20tableCode%20eq%20%2720%27%20or%20tableCode%20eq%20%2722%27%20or%20tableCode%20eq%20%2700%27%20or%20tableCode%20eq%20%2798%27)%20and%20%20procedureId%20startswith(%27CONSULTA%27)%20or%20procedureDescription%20startswith(%27CONSULTA%27)&procedureId=10101012

04. TELA XXXXX

Principais Campos e Parâmetros

...



Card documentos
InformacaoUse esse box para destacar informações relevantes e/ou de destaque.
TituloIMPORTANTE!

...