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	Filtro de medicamentos para somente o portal do beneficiário (BR8_EXPBEN), sendo: 0 - Medicamentos para não mostrar no portal do beneficiário 1 - Medicamentos para mostrar no portal do beneficiário
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 classes de procedimentos
items.class-code	string	Código da classe no sistema
items.description	string	Descrição da classe de procedimentos
items.is-medication	string	Indica se a classe é de medicamentos, sendo: 0 = Não 1 = Sim
items.class-type	string	Tipo da classe, sendo: 0 = Não aplicável 1 = Medicamento 2 = Seriado
items.standard-table-code	string	Código da tabela do procedimento padrão da classe
items.standard-procedure-code	string	Código do procedimento padrão da classe
items.procedure-description	string	Descrição do procedimento padrão
items.links	array

{
    "items": [
        {
            "class-code": "000001",
            "description": "CONSULTAS",
            "is-medication": "",
            "class-type": "",
            "standard-table-code": "",
            "standard-procedure-code": "",
            "procedure-description": "",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000001/procedures"
                }
            ]
        }
        {
            "class-code": "000002",
            "description": "EXAMES E TERAPIAS",
            "is-medication": "",
            "class-type": "",
            "standard-table-code": "",
            "standard-procedure-code": "",
            "procedure-description": "",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000002/procedures"
                }
            ]
        },
		{
            "class-code": "000005",
            "description": "MEDICAMENTOS",
            "is-medication": "1",
            "class-type": "1",
            "standard-table-code": "04",
            "standard-procedure-code": "0490173961",
            "procedure-description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000005/procedures"
                }
            ]
        }
    ],
    "hasNext": true,
    "remainingRecords": 6
}

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