CONTEÚDO

  1. Visão Geral
  2. Configurações INI
  3. Verbos
  4. Uso da API - POST
  5. Atributos de Resposta
  6. Tabelas utilizadas


01. VISÃO GERAL

A API professionals tem como objetivo realizar a inclusão e manutenção de profissionais de saúde. Primeiramente será disponibilizado o verbo POST onde é permitido realizar o cadastro de novos profissionais. Se os dados informados do professional já existirem na base, o JSON de resposta retornará os dados do professional já cadastrado.


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

POSThttps://<url>:porta>/rest/totvsHealthPlans/v1/professionalsRealiza o cadastro de um novo profissional de saúde

04. USO DA API - POST

A API não tem QueryParams específicos, ela recebe um JSON no body com o seguinte conteúdo:


Atributo

Tipo

Descrição

professionalCouncilCaracterConselho profissional
professionalCouncilNumberCaracter

Número do conselho

nameCaracterNome do profissional
stateAbbreviationCaracterSigla do estado



{
    "professionalCouncil": "CRM",
    "professionalCouncilNumber": "568122",
    "name": "PROF CRM MATO GROSSO",
    "stateAbbreviation": "MT"
}

05. ATRIBUTOS DE RESPOSTA

O JSON de resposta retorna o número do lote gerado no sistema de gestão SIGAPLS, valor do lote e quantidade de guias: