Exibir origem

CONTEÚDO

Visão Geral
Exemplo de utilização
1. Classes - Retorna as classes de procedimentos
2. Procedures - Retorna os procedimento da classe
Tela api classes
1. Outras Ações / Ações relacionadas
Tela api classes
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade professionals (Profissionais de saúde) do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui para detalhes sobre como habilitar o serviço de APIs

API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items

02. EXEMPLO DE UTILIZAÇÃO

Retorna as classes de procedimentos cadastradas pela operadora de saúde

/totvsHealthPlans/procedure/v1/classes

GET

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
health-insurer-code (query)	string	Código da operadora (BJE_CODINT)	*required
class-code (query)	string	Filtro de classes do pelo código no sistema (BJE_CODIGO)
is-medication (query)	string	Filtro de classes pelo tipo medicamento (BJE_ISMED), sendo: 0 = Não 1 = Sim
class-type (query)	string	Filtro de classes pelo tipo (BJE_TIPO), sendo: 0 = Não aplicável 1 = Medicamento 2 = Seriado
has-procedures (query)	string	Filtro de classes somente quando houver procedimento vinculado
is-beneficiary-portal (query)	string
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Body

Não possui body!

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de profissionais
items.id-on-health-insurer	string	Código do profissional no sistema	BB0_CODIGO	*required
items.name	string	Nome do profissional	BB0_NOME	*required
items.professional-council	string	Sigla Conselho Regional	BB0_CODSIG	*required
items.professional-council-number	string	Numero Conselho Regional	BB0_NUMCR	*required
items.state-abbreviation	string	Estado Conselho Regional	BB0_ESTADO	*required
items.professional-identifier	string	CPF/CNPJ do profissional	BB0_CGC
items.health-insurer-code-origem	string	Código da operadora origem do profissional	BB0_CODORI
items.is-part-attendance-network	string	Identifica se o profissional faz parte da rede de atendimento, sendo: 1 = Faz parte da Rede de Atendimento 2 = Não faz parte da Rede de Atendimento	BB0_VINC	*required
items.blocking-reason	string	Código do bloqueio do profissional	BB0_CODBLO
items.blocking-date	string (date)	Data do bloqueio do profissional	BB0_DATBLO

{
    "items": [
        {
            "id-on-health-insurer": "000052",
            "name": "RDA CRUZEIRO",
            "professional-council": "CRM",
            "professional-council-number": "2165465454",
            "state-abbreviation": "SP",
            "professional-identifier": "34622099000185",
            "health-insurer-code-origem": "",
            "is-part-attendance-network": "1",
            "blocking-reason": "",
            "blocking-date": ""
        },
        {
            "id-on-health-insurer": "000055",
            "name": "W RDA XML EXECUTANTE",
            "professional-council": "CRM",
            "professional-council-number": "1111",
            "state-abbreviation": "SP",
            "professional-identifier": "31233647040",
            "health-insurer-code-origem": "",
            "is-part-attendance-network": "1",
            "blocking-reason": "",
            "blocking-date": ""
        },
        {
            "id-on-health-insurer": "000058",
            "name": "W WANDERLEY RODRIGUES MOREIRA",
            "professional-council": "CRM",
            "professional-council-number": "17611",
            "state-abbreviation": "SP",
            "professional-identifier": "33325820620",
            "health-insurer-code-origem": "",
            "is-part-attendance-network": "1",
            "blocking-reason": "",
            "blocking-date": ""
        },
        {
            "id-on-health-insurer": "000059",
            "name": "PROFISSIONAL TESTE",
            "professional-council": "CRM",
            "professional-council-number": "697041",
            "state-abbreviation": "SP",
            "professional-identifier": "28845744337",
            "health-insurer-code-origem": "",
            "is-part-attendance-network": "2",
            "blocking-reason": "",
            "blocking-date": ""
        },
        {
            "id-on-health-insurer": "000062",
            "name": "PLS DSAUPC RDA NIVEL B29",
            "professional-council": "CRM",
            "professional-council-number": "123456",
            "state-abbreviation": "SP",
            "professional-identifier": "47782412587",
            "health-insurer-code-origem": "",
            "is-part-attendance-network": "1",
            "blocking-reason": "",
            "blocking-date": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 29
}

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave health-insurer-code obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

03. TELA XXXXX

Outras Ações / Ações relacionadas

Ação	Descrição
Inclua a ação	Inclua a descrição relacionada
Inclua a ação	Inclua a descrição relacionada
Inclua a ação	Inclua a descrição relacionada

04. TELA XXXXX

Principais Campos e Parâmetros

Campo	Descrição
Inclua o campo	Inclua a descrição relacionada
Inclua o campo	Inclua a descrição relacionada
Inclua o campo	Inclua a descrição relacionada

05. TABELAS UTILIZADAS

Coloque o link das tabelas relacionadas