Histórico da Página

...

Dica

title	Autenticação das 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.

Informações

title	Nomenclatura das APIs

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

...

Painel

titleColor	Orange
borderStyle	solid
title	Professionals - Retorna os profissionais de saúde

Retorna os profissionais de saúde cadastrados na operadora.

/totvsHealthPlans/attendanceNetwork/v1/professionals

GET

Nota

Expandir

title	Parameters

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
healthInsurerCode (query)	string	Código da operadora (BB0_CODOPE)	*required
idOnHealthInsurer (query)	string	Filtro de profissionais pelo código no sistema (BB0_CODIGO)
name (query)	string	Filtro de professionais pelo nome (BB0_NOME)
professionalCouncil (query)	string	Filtro de profissionais pela sigla do conselho regional (BB0_CODSIG)
professionalCouncilNumber (query)	string	Filtro de profissionais pelo numero do conselho regional (BB0_NUMCR)
stateAbbreviation (query)	string	Filtro de profissionais pelo estado do conselho regional (BB0_ESTADO)
professionalIdentifier (query)	string	Filtro de profissionais pelo CPF/CNPJ (BB0_CGC)
healthInsurerCodeOrigem (query)	string	Filtro de profissionais pelo código da operadora origem do profissional (BB0_CODORI)
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

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

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.idOnHealthInsurerid_on_health_insurer	string	Código do profissional no sistema	BB0_CODIGO	*required
items.name	string	Nome do profissional	BB0_NOME	*required
items.professionalCouncilprofessional_council	string	Sigla Conselho Regional	BB0_CODSIG	*required
items.professionalCouncilNumberprofessional_council_number	string	Numero Conselho Regional	BB0_NUMCR	*required
items.stateAbbreviationstate_abbreviation	string	Estado Conselho Regional	BB0_ESTADO	*required
items.professionalIdentifierprofessional_identifier	string	CPF/CNPJ do profissional	BB0_CGC
items.healthInsurerCodeOrigemhealthInsurer_code_origem	string	Código da operadora origem do profissional	BB0_CODORI
items.isPartAttendanceNetworkis_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.blockingReasonblocking_reason	string	Código do bloqueio do profissional	BB0_CODBLO
items.blockingDateblocking_date	string (date)	Data do bloqueio do profissional	BB0_DATBLO

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "idOnHealthInsurerid_on_health_insurer": "000052",
            "name": "RDA CRUZEIRO",
            "professionalCouncilprofessional_council": "CRM",
            "professionalCouncilNumberprofessional_council_number": "2165465454",
            "stateAbbreviationstate_abbreviation": "SP",
            "professionalIdentifierprofessional_identifier": "34622099000185",
            "healthInsurerCodeOrigemhealth_insurer_code_origem": "",
            "isPartAttendanceNetworkis_part_attendance_network": "1",
            "blockingReasonblocking_reason": "",
            "blockingDateblocking_date": ""
        },
        {
            "idOnHealthInsurerid_on_health_insurer": "000055",
            "name": "W RDA XML EXECUTANTE",
            "professionalCouncilprofessional_council": "CRM",
            "professionalCouncilNumberprofessional_council_number": "1111",
            "stateAbbreviationstate_abbreviation": "SP",
            "professionalIdentifierprofessional_identifier": "31233647040",
            "healthInsurerCodeOrigemhealth_insurer_code_origem": "",
            "isPartAttendanceNetworkis_part_attendance_network": "1",
            "blockingReasonblocking_reason": "",
            "blockingDateblocking_date": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 29
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "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 healthInsurerCode obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave healthInsurerCode."
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

02. EXEMPLO DE UTILIZAÇÃO