Linha Microsiga Protheus

Árvore de páginas


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 Credenciada
    1. Outras Ações / Ações relacionadas
  4. Tela API Rede Credenciada
    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


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

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      
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
portalProduct (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


Body

Não possui body!

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

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      
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

Body

Não possui body!

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
Exemplo
{
  "productid": "0001",
  "version": "001",
  "description": "PRODUTO EXEMPLO 1",
  "coverage": "01",
  "susep": "123456",
  "segmentation": "001",
  "scpaCode": ""
}
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
Exemplo
{
    "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."
        }
    ]
}
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
Exemplo 1
{
    "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 ."
}
Exemplo 2
{
    "code": "E003",
    "message": "Plano encontrado,porém, verificar se o mesmo está habilitado/ ativo.",
    "detailedMessage": "Verificar campo BI3_STATUS."
}

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      
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


Body

Não possui body!

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

ReferencedNetworks - Retorna as redes credenciadas disponíveis para atendimento de acordo com o plano de saúde e especialidade informada

Retorna as redes credenciadas disponíveis para atendimento de acordo com o plano de saúde e especialidade informada

/totvsHealthPlans/attendanceNetwork/v1/healthProducts/:healthProducId/specialties/:specialtieCode/referencedNetworks

      GET      
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
healthProducId (Path)stringProduto Saúde (BI3_CODIGO + BI3_VERSAO)*required
specialtieCode (Path)stringEspecialidade disponível no produto saúde*required
healthInsurerCode (query)stringCódigo da operadora do produto Saúde (BI3_CODINT)*required
zipCode (query)stringFiltro por CEP (Caso informado o mesmo, não será considerado stateAbbreviation e cityCode caso informado)
stateAbbreviation (query)string

Filtro por Estado

Exemplo: SP


cityCode (query)string

Filtro pelo Código da Cidade

Exemplo: 3550308 (São Paulo)


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


Body

Não possui body!

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.codeIdstringCódigo de cadastro do prestador
*required
items.providerNamestringNome do prestador
*required
items.localDescriptionstringDescrição do prestador
*required
items.zipCodestringCEP do prestador
*required
items.addressNumberstringNúmero do endereço do prestador
*required
items.cityCodestringCódigo da cidade do prestador
*required
items.citystringCidade do prestador
*required
items.statestringEstado do prestador
*required
items.districtstringBairro do prestador
*required
items.DDDstringCódigo de área do telefone do prestador

items.telephonestringTelefone do prestador

items.CNESstringCNES do prestador

Exemplo
{
    "items": [
        {
            "codeId": "000004",
            "providerName": "HOSPITAL BOM CLIMA",
            "localDescription": "HOSPITAIS",
            "zipCode": "07197000",
            "address": "MARIANA UBALDINA DO ESPÍRITO SANTO",
            "addressNumber": "654",
            "cityCode": "3518800",
            "city": "GUARULHOS",
            "state": "SP",
            "district": "BOM CLIMA",
            "DDD": "",
            "telephone": "",
            "CNES": ""
        },
        {
            "codeId": "000011",
            "providerName": "UNIMED SUL CAPIXABA",
            "localDescription": "OPERADORAS",
            "zipCode": "07197000",
            "address": "MARIANA UBALDINA DO ESPÍRITO SANTO",
            "addressNumber": "100",
            "cityCode": "3518800",
            "city": "GUARULHOS",
            "state": "SP",
            "district": "BOM CLIMA",
            "DDD": "",
            "telephone": "",
            "CNES": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 26
}
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
Exemplo 1
{
    "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."
        }
    ]
}
Exemplo 2
{
    "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": "E002E-406",
            "message": "Tamanho inválido para o campo healthProduct",
            "detailedMessage": "O valor do campo healthProduct deve ter o tamanho 7."
        },
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo specialtieCode",
            "detailedMessage": "O valor do campo specialtieCode deve ter o tamanho 3."
        }
    ]
}


03. TELA Rede Credenciada

Outras Ações / Ações relacionadas

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

04. TELA Rede Credenciada

Principais Campos e Parâmetros

CampoDescrição
BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITOMatricula do beneficiário no sistema
BI3_CODIGO+BI3_VERSAOCódigo do Produto Saúde no sistema
BAQ_ESPCódigo da Especialidade no Sistema

05. TABELAS UTILIZADAS

  • Beneficiários (BA1)
  • Produto Saúde (BI3)
  • Especialidades (BAQ)
  • Especialidade do Local (BAX)
  • Redes de Atendimento (BAU)
  • Locais de Rede Atendimento (BB8)
  • Redes de Atendimento Planos (BB6)
  • Planos Autorizados (BBI)
  • RDA x Plano (B30)
  • Planos Rede de Atendimento (BT4)