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.
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:
Seguem os verbos disponíveis na API:
Verbo | URL | Descrição |
|---|---|---|
| POST | https://<url>:porta>/rest/totvsHealthPlans/v1/professionals | Realiza o cadastro de um novo profissional de saúde |
A API não tem QueryParams específicos, ela recebe um JSON no body com o seguinte conteúdo:
No header, é obrigatório o envio das chaves:
| Chave | Valor |
|---|---|
| x-erp-module | 33 |
| x-totvs-app | PLS |
| authorization | BASIC <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:
Dados do payload de envio:
Atributo | Tipo | Descrição |
|---|---|---|
| professionalCouncil | Caracter | Conselho profissional |
| professionalCouncilNumber | Caracter | Número do conselho |
| name | Caracter | Nome do profissional |
| stateAbbreviation | Caracter | Sigla do estado |
{
"professionalCouncil": "CRM",
"professionalCouncilNumber": "568122",
"name": "PROF CRM MATO GROSSO",
"stateAbbreviation": "MT"
}
O JSON de resposta retorna os dados do profissional cadastrado:
{
"healthInsurerId": "0001",
"idOnHealthInsurer": "A02037",
"name": "PROF CRM MATO GROSSO",
"professionalCouncil": "CRM",
"professionalCouncilNumber": "568122",
"stateAbbreviation": "MT"
}
{
"code": 400,
"message": "Bad Request",
"detailedMessage": "Atributo 'name' nao informado",
"helpUrl": "",
"details": [
{
"code": "",
"message": "",
"detailedMessage": "",
"helpUrl": ""
}
]
}
Os profissionais serão cadastrados na tabela BB0 - Profissionais de Saúde.