Árvore de páginas

Versões comparadas

Chave

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


CONTEÚDO

  1. Visão Geral
  2. Configuração INI
  3. Verbos
  4. Exemplo de Chamada da API
  5. Atributos de Resposta
  6. Exemplos de JSON de Resposta


01. VISÃO GERAL

A API healthProviders tem como objetivo, trabalhar com ações relacionadas aos dados de uma Rede de Atendimento, trazendo seus locais de atendimento e especialidades.

...

Através do verbo GET, informamos a Rede de Atendimento através de PathParam.

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

image2020-12-17_15-28-30.pngImage Modified

Logo, a minha URL será: http://localhost:8080/rest/healthProviders

03. VERBOS

Seguem os verbos disponíveis na API:

VerboPathPathParamDescrição
GEThealthProviders/{healthProviderCode}healthProviderCodeCódigo da RDA

04. EXEMPLO DE CHAMADA DA API

Chamada GET

Exemplo solicitando dados da RDA 000004:

http://spon019400235:8080/rest/totvshealthplans/v1/healthProviders/000004

...

04. ATRIBUTOS DE RESPOSTA

Chamada GET

Cabeçalho

Atributo CampoTipo
healthProviderIdBAU_CODIGOCaracter
nameBAU_NOMECaracter
attendanceLocation
Array


Atributo attendanceLocation

Atributo CampoTipo
addressBB8_ENDCaracter
locationCodeBB8_CODLOCCaracter
specialities
Array


Atributo attendanceLocation

Atributo CampoTipo
specialtyCodeBAX_CODESPCaracter
specialtyDescriptionBAQ_DESCRICaracter


06. EXEMPLOS DE JSON DE RESPOSTA