Árvore de páginas

Versões comparadas

Chave

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


CONTEÚDO

  1. Visão Geral
  2. 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
  3. Tela API rede de Atendimento
    1. Outras Ações / Ações relacionadas
  4. Tela API rede de Atendimento
    1. Principais Campos e Parâmetros
  5. 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
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
healthProducts
healthProducts

Painel
titleColorOrange
titleHealthproducts - 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)stringCabeç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)stringCó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
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizado com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de beneficiários retornados

items.productIdstringCódigo do produto saúdeBI3_CODIGO*required
items.versionstringVersão do produto saúdeBI3_VERSAO*required
items.descriptionstringDescrição do produto saúdeBI3_DESCRI*required
items.coveragestringAbrangência do produto saúdeBI3_ABRANG
items.susepstringNúmero de registro Ans do produto saúdeBI3_SUSEP
items.segmentationstringSegmentação do produto saúdeBI3_CODSEG
items.scpaCodestringCódigo SCPA do produto saúdeBI3_SCPA
Bloco de código
themeEmacs
linenumberstrue
{
    "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
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 healthInsurerCode obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave healthInsurerCode."
        }
    ]
}

Âncora
healthProductsBeneficiary
healthProductsBeneficiary

Painel
titleColorOrange
titleHealthProductsBeneficiary - 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)stringCabeç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)stringMatricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)*required
Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizado com sucesso
productIdstringCódigo do produto saúdeBI3_CODIGO*required
versionstringVersão do produto saúdeBI3_VERSAO*required
descriptionstringDescrição do produto saúdeBI3_DESCRI*required
coveragestringAbrangência do produto saúdeBI3_ABRANG
susepstringNúmero de registro Ans do produto saúdeBI3_SUSEP
segmentationstringSegmentação do produto saúdeBI3_CODSEG
scpaCodestringCódigo SCPA do produto saúdeBI3_SCPA
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
  "productid": "0001",
  "version": "001",
  "description": "PRODUTO EXEMPLO 1",
  "coverage": "01",
  "susep": "123456",
  "segmentation": "001",
  "scpaCode": ""
}
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": "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
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": "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
titleColorOrange
titleSpecialties - 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)stringCabeç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)stringCó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
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizado com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de beneficiários retornados

items.codeEspstringCódigo da especialidade

BAQ_CODESP

*required
items.descriptionstringDescrição da especialidade

BAQ_DESCRI

*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "items": [
        {
            "codeEsp": "017",
            "description": "ALERGIA E IMUNOLOGIA"
        },
        {
            "codeEsp": "015",
            "description": "ANESTESIOLOGIA"
        }
    ],
    "hasNext": true,
    "remainingRecords": 29
}
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 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çãoDescrição
Não se aplicaNão se aplica

04. TELA Rede de Atendimento

Principais Campos e Parâmetros

CampoDescrição


Card documentos
InformacaoUse esse box para destacar informações relevantes e/ou de destaque.
TituloIMPORTANTE!

05. TABELAS UTILIZADAS