Histórico da Página
CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Tela XXX
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela XXX
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Configurações INI
- Verbos
- Uso da API - POST
- Atributos de Resposta
- 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 |
---|---|---|
POST | https://<url>:porta>/rest/totvsHealthPlans/v1/professionals | Realiza 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:
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 |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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 | ||||
---|---|---|---|---|
| ||||
{
"healthInsurerId": "0001",
"idOnHealthInsurer": "A02037",
"name": "PROF CRM MATO GROSSO",
"professionalCouncil": "CRM",
"professionalCouncilNumber": "568122",
"stateAbbreviation": "MT"
} |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{
"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.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas