Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 9

changes.mady.by.user Vinicius Queiros Teixeira

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Guilherme Augusto Arcanjo Bonni

Gravado em

Chave

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

...

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.

Informações
titleNomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase


02. EXEMPLO DE UTILIZAÇÃO

...

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.

/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."
}

...