Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. Exemplo de utilização
    1. Protocols - Inclusão de protocolo de autorização
    2. Protocols - Retorna os protocolos de autorização do beneficiário
    3. Protocols/interactions - Retorna as interações do protocolo de autorização
    4. Protocols/attachments Authorizations/protocols - Inclusão de anexos no protocolo de autorização
  3. Tela api authorizations 
    1. Outras Ações / Ações relacionadas
  4. Tela XXXapi authorizations
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas

...

01. VISÃO GERAL

API para a entidade authorauthorizations (ReembolsosAutorizações) do produto TOTVS Saúde Planos Linha Protheus.

...

Dica
titleAutenticaçã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.


02. EXEMPLO DE UTILIZAÇÃO

Âncora
protocolsPost
protocolsPost

Painel
titleColorOrange
borderStylesolid
titleProtocols - Inclusão de protocolo de autorização

Realiza a inclusão de um protocolo de solicitação de autorização para operadora.

/totvsHealthPlans/attendance/v1/authorizations/protocols

POST

Nota
Expandir
titleParameters
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
Dica
Expandir
titleRequest
subscriberIdstring

Matricula do beneficiário solicitante do protocolo de autorização

(obtido através da API Beneficiaries - v1.000 (Family Contract))

BKU_MATUSR*required

stateAbbreviation

stringEstado do conselho regional do profissional de saúde solicitanteBKU_UF
professionalCouncilstring

Sigla do conselho regional do profissional de saúde solicitante

(obtido através da API RegionalCouncils - v1.000 (Attendance Network))

BKU_SIGLA
professionalCouncilNumberstringNumero do conselho regional do profissional de saúde solicitanteBKU_REGSOL
professionalNamestring

Nome do profissional de saúde solicitante

(obtido através da API Professionals - v1.000 (Attendance Network))

BKU_NOMSOL*required
attachmentsarrayAnexos da solicitação de autorização
*required
attachments.hrefstringUrl do arquivo para que seja realizado o download
*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
	"subscriberId" : "00011008000027010",
	"stateAbbreviation" : "SP",
	"professionalCouncil" : "CRM",
	"professionalCouncilNumber" : "1234567",
	"professionalName" : "VINICIUS",
	"attachments" : [
        {
            "href" : "https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg"
        }
	]
}
Dica
Expandir
title(201) - Operação realizada com sucesso
protocolstringNumero do protocolo gerado para a solicitação de autorizaçãoBKU_NRPRO*required
namestring

Nome do beneficiário solicitante

BKU_NOMUSR*required
subscriberIdstringMatricula do beneficiário solicitanteBKU_MATUSR*required
professionalNamestringNome do profissional solicitanteBKU_NOMSOL*required
stateAbbreviationstringEstado do conselho regional do profissional solicitanteBKU_UF
professionalCouncilstringSigla do conselho regional do profissional solicitanteBKU_SIGLA
professionalCouncilNumberstring

Numero do conselho regional do profissional solicitante

BKU_REGSOL
statusstring

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
idOnHealthInsurerstringNumero da autorização gerada pelo sistema depois de aprovada a solicitação.BKU_NUMAUT
authTypestring

Tipo da solicitação, sendo:

  • 2 = SADT
  • 3 = Internação
  • 4 = Odontológico                                                                                              
BKU_TIPO
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "protocol": "41750520230620000003",
    "name": "HERNANDES ALVES DA SILVA",
    "subscriberId": "00011008000027010",
    "professionalName": "VINICIUS",
    "stateAbbreviation": "SP",
    "professionalCouncil": "CRM",
    "professionalCouncilNumber": "1234567",
    "status": "7",
    "idOnHealthInsurer": "",
    "authType": ""
}
Aviso
Expandir
title(406) - Json do body invalido
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"professionalCouncilNumber\" : \"1234567\",\r\n\t\"professionalName\" : \"VINICIUS\",\r\n\t\"attachments\" : [\r\n        {\r\n            \"href\" : \"https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg\"\r\n        }\r\n\t]\r\n}<<"
}
Aviso
Expandir
title(406) - Campos inválidos
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002D-406",
            "message": "Tipo inválido para o campo professionalCouncilNumber",
            "detailedMessage": "O valor do campo professionalCouncilNumber deve ser do tipo (C)."
        },
        {
            "code": "E002B-406",
            "message": "Campo professionalName obrigatório",
            "detailedMessage": "Não foi informado valor do campo professionalName."
        }
    ]
}
Aviso
Expandir
title(404) - Beneficiário não encontrado
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E003",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027011"
}
Aviso
Expandir
title(400) - Dados inválidos
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E004",
    "message": "Erro ao incluir protocolo de autorização",
    "detailedMessage": "Verifique a lista de erros para mais detalhes",
    "details": [
        {
            "code": "E004-1",
            "message": "Erro ao realizar download do arquivo.",
            "detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://img.olhardigital.com.br/wp-content/ploads/2019/01/20190115163721.jpg"
        }
    ]
}

Âncora
protocolsGet
protocolsGet

Painel
titleColorOrange
borderStylesolid
titleProtocols - Retorna os protocolos de autorização do beneficiário

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

Informações
titleNomenclatura 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

...

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

GET

Nota
Expandir
titleParameters
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)stringFiltro pelo numero do protocolo (BKU_NRPRO)
protocolOrAuthorization (query)stringFiltro pelo numero do protocolo (BKU_NRPOP) ou numero da autorização (BKU_NUMAUT)
solicitationDate (query)stringFiltro 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
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de protocolos de autorizações

items.protocolstring

Numero do protocolo gerado para a solicitação de autorização

BKU_NRPRO*required
items.namestringNome do beneficiário solicitanteBKU_NOMUSR*required
items.subscriber_idstringMatricula do beneficiário solicitanteBKU_MATUSR*required
items.professional_namestringNome do profissional solicitanteBKU_NOMSOL*required
items.professional_councilstringSigla do conselho regional do profissional solicitanteBKU_SIGLA
items.professional_council_numberstringNumero do conselho regional do profissional solicitanteBKU_REGSOL
items.statusstring

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_insurerstringNumero da autorização gerada pelo sistema depois de aprovada a solicitaçãoBKU_NUMAUT
items.auth_typestring

Tipo da solicitação, sendo:

  • 2 = SADT
  • 3 = Internação
  • 4 = Odontológico
BKU_TIPO
items.solicitation_datestring

Data da Solicitação

BKU_DATSOL
items.analysis_datestring

Data de Análise da Solicitação

BKU_DATANA
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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": "",
			"solicitation_date": "",
			"analysis_date": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 3
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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."
}

Âncora
interactions
interactions

Painel
titleColorOrange
borderStylesolid
titleProtocols/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
titleParameters
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
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de interações do protocolo

items.sectorstring

Setor do usuário da interação

BBR_SETOR*required
items.namestringNome do beneficiárioBKU_NOMUSR*required
items.interaction_datestring (date)Data da interaçãoBBR_DTITER*required
items.default_reasonstringMotivo padrão da interaçãoBBP_DESMOT*required
items.observationstringObservação da interaçãoBBP_OBSERV*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E002",
    "message": "Protocolo não encontrado",
    "detailedMessage": "Não foi possível retornar os dados da interação através do protocolo informado."
}

Âncora
attachments
attachments

Painel
titleColorOrange
borderStylesolid
titleProtocols/attachments - Inclusão de anexos no protocolo de autorização

Realiza a inclusão de anexos no protocolo de autorização

/totvsHealthPlans/attendance/v1/authorizations/protocols/attachments

POST

Nota
Expandir
titleParameters
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
Dica
Expandir
titleRequest
protocolstring

Numero do protocolo de autorização

BKU_NRPRO*required
attachmentsarrayAnexos
*required
attachments.hrefstringUrl do arquivo para que seja realizado o download
*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "protocol" : "41750520230620000004",
    "attachments" : [
        {
            "href" : "https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg"
        }
    ]
}
Dica
Expandir
title(201) - Operação realizada com sucesso
protocolstringNumero do protocolo da solicitação de autorizaçãoBKU_NRPRO*required
namestring

Nome do beneficiário solicitante

BKU_NOMUSR*required
subscriberIdstringMatricula do beneficiário solicitanteBKU_MATUSR*required
professionalNamestringNome do profissional solicitanteBKU_NOMSOL*required
stateAbbreviationstringEstado do conselho regional do profissional solicitanteBKU_UF
professionalCouncilstringSigla do conselho regional do profissional solicitanteBKU_SIGLA
professionalCouncilNumberstring

Numero do conselho regional do profissional solicitante

BKU_REGSOL
statusstring

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*required
idOnHealthInsurerstringNumero da autorização gerada pelo sistema depois de aprovada a solicitação.BKU_NUMAUT
authTypestring

Tipo da solicitação, sendo:

  • 2 = SADT
  • 3 = Internação
  • 4 = Odontológico                                                                                              
BKU_TIPO
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "protocol": "41750520230620000003",
    "name": "HERNANDES ALVES DA SILVA",
    "subscriberId": "00011008000027010",
    "professionalName": "VINICIUS",
    "stateAbbreviation": "SP",
    "professionalCouncil": "CRM",
    "professionalCouncilNumber": "1234567",
    "status": "7",
    "idOnHealthInsurer": "",
    "authType": ""
}
Aviso
Expandir
title(406) - Json do body invalido
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"attachments\" : [\r\n        {\r\n            \"href\" : \"https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg\"\r\n        }\r\n    ]\r\n}<<"
}
Aviso
Expandir
title(406) - Campos inválidos
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002D-406",
            "message": "Tipo inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ser do tipo (C)."
        },
        {
            "code": "E002B-406",
            "message": "Campo attachments obrigatório",
            "detailedMessage": "Não foi informado valor do campo attachments."
        }
    ]
}
Aviso
Expandir
title(404) - Protocolo não encontrado
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E004",
    "message": "Protocolo nâo encontrado",
    "detailedMessage": "Não foi encontrado nenhum protocolo, informe um protocolo válido"
}
Aviso
Expandir
title(400) - Status não permitido
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E003",
    "message": "Status inválido",
    "detailedMessage": "O Status do protocolo não permite o envio de anexos"
}
Aviso
Expandir
title(400) - Dados inválidos
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E007",
    "message": "Erro ao incluir um anexo",
    "detailedMessage": "Verifique a lista de erros para mais detalhes",
    "details": [
        {
            "code": "E006-1",
            "message": "Erro ao realizar download do arquivo.",
            "detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://img.olhardigital.com.br/wp-content/uploads/2019/01/2019011516321.jpg"
        }
    ]
}

03. TELA AUTHORIZATIONS

Outras Ações / Ações relacionadas

AçãoDescrição
Não se aplicaNão se aplica

04. TELA

...

AUTHORIZATIONS

Principais Campos e Parâmetros

CampoDescrição

...

BKU_NRPRONumero do protocolo gerado para a solicitação de autorização
BKU_STATUSStatus do protocolo de solicitação de autorização
BKU_NUMAUTNumero da autorização gerada pelo sistema depois de aprovada a solicitação.

...

05. TABELAS UTILIZADAS

  • Beneficiários (BA1)
  • Upload de Guia Beneficiário (BKU)
  • Bancos de Conhecimentos (ACB)
  • Relação de Objetos x Entidades (AC9)
  • Controle de Interações (BBR)
  • Motivo Padrão (BBP)