Á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. Exemplo de utilização
  3. Tela XXX
    1. Outras Ações / Ações relacionadas
  4. Tela XXX
    1. Principais Campos e Parâmetros
  5. Configurações INI
  6. Verbos
  7. Uso da API - POST
  8. Atributos de Resposta
  9. Tabelas utilizadas


01. VISÃO GERAL

...

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:

Image Modified

No header, é obrigatório o envio das chaves:

ChaveValor
x-erp-module33
x-totvs-appPLS
authorizationBASIC <usuário:senha em BASE 64> (Enviar somente se a API do PLS solicitar autenticação)


Profissional gerado no sistema de gestão Plano de Saúde:

Image Added


Dados do payload de envio:

Atributo

Tipo

Descrição

professionalCouncilCaracterConselho profissional
professionalCouncilNumberCaracter

Número do conselho

nameCaracterNome do profissional
stateAbbreviationCaracterSigla do estado
Bloco de código
titleExemplo JSON de Envio
linenumberstrue
{
    "professionalCouncil": "CRM",
    "professionalCouncilNumber": "568122",
    "name": "PROF CRM MATO GROSSO",
    "stateAbbreviation": "MT"
}

05. ATRIBUTOS DE RESPOSTA

O JSON de resposta retorna os dados do profissional cadastrado:

Bloco de código
titleSucesso 202
linenumberstrue
{
    "healthInsurerId": "0001",
    "idOnHealthInsurer": "A02037",
    "name": "PROF CRM MATO GROSSO",
    "professionalCouncil": "CRM",
    "professionalCouncilNumber": "568122",
    "stateAbbreviation": "MT"
}
Bloco de código
titleErro 400
linenumberstrue
{
    "code": 400,
    "message": "Bad Request",
    "detailedMessage": "Atributo 'name' nao informado",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}


06. TABELAS UTILIZADAS

Os profissionais serão cadastrados na tabela BB0 - Profissionais de Saúde.