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	Protocols - Retorna os protocolos de autorização do beneficiário

Retorna os protocolos de solicitação de autorização do beneficiário.

/totvsHealthPlans/attendance/v1/authorizations/{subscriberId}/protocols

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
subscriberId (path)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) (obtido através da API Beneficiaries - v1.000 (Family Contract))	*required
protocol (query)	string	Filtro pelo numero do protocolo (BKU_NRPRO)

status


protocolOrAuthorization (query)	string	Filtro pelo

status

1 = Autorizada

2 = Autorizada Parcialmente

3 = Não Autorizada

numero do protocolo

de autorização, sendo:

(BKU_NRPOP) ou numero da autorização (BKU_NUMAUT)

solicitationDate (query)

string

Filtro pela data de solicitação (BKU_DATSOL)

status (query)

string

Filtro pelo status do protocolo de autorização, sendo:

1 = Autorizada
2 = Autorizada Parcialmente
3 = Não Autorizada

6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento pode ser enviado mais de um status. Exemplo: 1,2,3
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 protocolos de autorizações
items.protocol	string	Numero do protocolo gerado para a solicitação de autorização	BKU_NRPRO	*required
items.name	string	Nome do beneficiário solicitante	BKU_NOMUSR	*required
items.subscriber	_id	string	Matricula do beneficiário solicitante	BKU_MATUSR	*required
items.professional	_name	string	Nome do profissional solicitante	BKU_NOMSOL	*required
items.professional	_council	string	Sigla do conselho regional do profissional solicitante	BKU_SIGLA
items.professional	_council	_number	string	Numero do conselho regional do profissional solicitante	BKU_REGSOL
items.status	string	Status do protocolo de solicitação de autorização, sendo: 1 = Autorizada 2 = Autorizada Parcialmente 3 = Não Autorizada 6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento	BKU_STATUS
items.id	_on	_health	_insurer	string	Numero da autorização gerada pelo sistema depois de aprovada a solicitação	BKU_NUMAUT
items.auth	_type	string	Tipo da solicitação, sendo: 2 = SADT 3 = Internação 4 = Odontológico	BKU_TIPO
items.solicitation_date	string	Data da Solicitação	BKU_DATSOL
items.analysis_date	string	Data de Análise da Solicitação	BKU_DATANA

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "protocol": "41750520230601000030",
            "name": "HERNANDES ALVES DA SILVA",
            "subscriber-_id": "00011008000027010",
            "professional-_name": "ANDRE",
            "professional-_council": "CRM",
            "professional-_council-_number": "334455",
            "status": "7",
            "id-_on-_health-_insurer": "",
            "auth-type_type": "",
			"solicitation_date": "",
			"analysis_date": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 3
}

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

Aviso

Expandir

title	(404) - Beneficiário não encontrado

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Usuário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

...

Painel

titleColor	Orange
borderStyle	solid
title	Protocols/interactions - Retorna as interações do protocolo de autorização

Retorna as interações do protocolo de autorização com o beneficiário

/totvsHealthPlans/attendance/v1/authorizations/protocols/{protocolId}/interactions

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
protocolId (path)	string	Numero do protocolo de autorização (BKU_NRPRO)	*required
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 interações do protocolo
items.sector	string	Setor do usuário da interação	BBR_SETOR	*required
items.name	string	Nome do beneficiário	BKU_NOMUSR	*required
items.interaction-_date	string (date)	Data da interação	BBR_DTITER	*required
items.default-_reason	string	Motivo padrão da interação	BBP_DESMOT	*required
items.observation	string	Observação da interação	BBP_OBSERV	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "sector": "DEPARTAMENTO PADRAO",
            "name": "HERNANDES ALVES DA SILVA",
            "interaction-_date": "2023-06-20",
            "default-_reason": "FALTA DE DOCUMENTAÇÃO DO BENEFICIÁRIO",
            "observation": "Encaminhar a documentação do beneficiário"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

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

Aviso

Expandir

title	(404) - Protocolo não encontrado

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Protocolo não encontrado",
    "detailedMessage": "Não foi possível retornar os dados da interação através do protocolo informado."
}

...

Árvore de páginas

Versões comparadas

Versão antiga 7

Nova versão Atual

Chave

02. EXEMPLO DE UTILIZAÇÃO