Histórico da Página

CONTEÚDO

Visão Geral
Exemplo de utilização
1. HealthProducts- Retorna os planos de saúde da operadora de saúde
2. HealthProductsBeneficiary - Retorna o plano de saúde do beneficiário logado
3. Specialties - Retorna as especialidades disponíveis da operadora de saúde
4. ReferencedNetworks - Retorna as redes credenciadas disponíveis para atendimento de acordo com o plano de saúde e especialidade informada
Tela API rede de Atendimento
1. Outras Ações / Ações relacionadas
Tela API rede de Atendimento
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade redes de atendimento do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui par detalhes sobre como habilitar o serviço de APIs

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.

02. EXEMPLO DE UTILIZAÇÃO

Âncora

	healthProducts
	healthProducts

Painel

titleColor	Orange
title	Healthproducts - Retorna os planos de saúde disponíveis na operadora de saúde

Retorna os planos de saúde disponíveis na operadora de saúde

totvsHealthPlans/attendanceNetwork/v1/healthProducts

GET

Nota

Expandir

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 (BAU_CODINT)	*required
productPortal (query)	string	Define se irá retornar apenas produtos configurados para serem exibidos no portal, sendo: 0 - Não 1 - Sim
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

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizado 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 beneficiários retornados
items.productId	string	Código do produto saúde	BI3_CODIGO	*required
items.version	string	Versão do produto saúde	BI3_VERSAO	*required
items.description	string	Descrição do produto saúde	BI3_DESCRI	*required
items.coverage	string	Abrangência do produto saúde	BI3_ABRANG
items.susep	string	Número de registro Ans do produto saúde	BI3_SUSEP
items.segmentation	string	Segmentação do produto saúde	BI3_CODSEG
items.scpaCode	string	Código SCPA do produto saúde	BI3_SCPA

Bloco de código

theme	Emacs
linenumbers	true

{
    "items": [
        {
            "productid": "0001",
            "version": "001",
            "description": "PRODUTO EXEMPLO 1",
            "coverage": "01",
            "susep": "123456",
            "segmentation": "001",
            "scpaCode": ""
        },
        {
            "productid": "0002",
            "version": "001",
            "description": "PRODUTO INTERCAMBIO",
            "coverage": "01",
            "susep": "423423423",
            "segmentation": "001",
            "scpaCode": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 58
}

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

Âncora

	healthProductsBeneficiary
	healthProductsBeneficiary

Painel

titleColor	Orange
title	HealthProductsBeneficiary - Retorna o plano de saúde do beneficiário logado

Retorna o plano de saúde do beneficiário logado

/totvsHealthPlans/attendanceNetwork/v1/healthProductsBeneficiary

GET

Nota

Expandir

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)	*required

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

productId	string	Código do produto saúde	BI3_CODIGO	*required
version	string	Versão do produto saúde	BI3_VERSAO	*required
description	string	Descrição do produto saúde	BI3_DESCRI	*required
coverage	string	Abrangência do produto saúde	BI3_ABRANG
susep	string	Número de registro Ans do produto saúde	BI3_SUSEP
segmentation	string	Segmentação do produto saúde	BI3_CODSEG
scpaCode	string	Código SCPA do produto saúde	BI3_SCPA

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
  "productid": "0001",
  "version": "001",
  "description": "PRODUTO EXEMPLO 1",
  "coverage": "01",
  "susep": "123456",
  "segmentation": "001",
  "scpaCode": ""
}

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": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        }
    ]
}

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": "E002",
    "message": "Não encontrado o(a) Beneficário(a) informado(a).",
    "detailedMessage": "Não foi encontrado o(a) beneficiario(a) com a matricula 00021077000004020 ."
}

Âncora

	#Specialties
	#Specialties

Painel

titleColor	Orange
title	Specialties - Retorna as especialidades disponíveis da operadora de saúde

Retorna as especialidades disponíveis da operadora de saúde

/totvsHealthPlans/attendanceNetwork/v1/specialties

GET

Nota

Expandir

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 (BAU_CODINT)	*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

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizado 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 beneficiários retornados
items.codeEsp	string	Código da especialidade	BAQ_CODESP	*required
items.description	string	Descrição da especialidade	BAQ_DESCRI	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "codeEsp": "017",
            "description": "ALERGIA E IMUNOLOGIA"
        },
        {
            "codeEsp": "015",
            "description": "ANESTESIOLOGIA"
        }
    ],
    "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."
        }
    ]
}

03. TELA Rede de Atendimento

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica	Não se aplica

04. TELA Rede de Atendimento

Principais Campos e Parâmetros

Campo	Descrição

Card documentos

Informacao	Use esse box para destacar informações relevantes e/ou de destaque.
Titulo	IMPORTANTE!

Árvore de páginas

Versões comparadas

Versão antiga 13

Nova versão 14

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. TELA Rede de Atendimento

04. TELA Rede de Atendimento

05. TABELAS UTILIZADAS