CONTEÚDO
- Visão Geral
- Exemplo de utilização
- HealthProducts- Retorna os planos de saúde da operadora de saúde
- HealthProductsBeneficiary - Retorna o plano de saúde do beneficiário logado
- Specialties - Retorna as especialidades disponíveis da operadora de saúde
- ReferencedNetworks - Retorna as redes credenciadas disponíveis para atendimento de acordo com o plano de saúde e especialidade informada
- Tela API rede de AtendimentoRede Credenciada
- Outras Ações / Ações relacionadas
- Tela API rede de AtendimentoRede Credenciada
- 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.
...
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 portalProduct (query) | string | Define se irá retornar apenas produtos configurados para serem exibidos no portal, sendo: |
| 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 |
---|
| 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 |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"items": [
{
"productidproductId": "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."
}
]
} |
|
|
|
...
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 |
---|
| 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/ Produto Saúde Inativo |
---|
| 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 1 |
---|
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 ."
} |
|
|
|
...
...
...
|
panel | titleColor | OrangeEmacs | title | Exemplo 2 |
---|
linenumbers | true |
---|
| {
"code": "E003",
"message": "Plano encontrado,porém, verificar se o mesmo está habilitado/ ativo.",
"detailedMessage": "Verificar campo BI3_STATUS."
} |
|
|
|
---|
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 |
---|
| 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 |
---|
| {
|
|
|
| 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 |
---|
|
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
...
Âncora |
---|
| ReferencedNetworks |
---|
| ReferencedNetworks |
---|
|
Painel |
---|
titleColor | Orange |
---|
title | 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 |
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 | healthProducId (Path) | string | Produto Saúde (BI3_CODIGO + BI3_VERSAO) | *required | specialtieCode(Path) | string | Especialidade disponível no produto saúde | *required | healthInsurerCode (query) | string | Código da operadora do produto Saúde (BI3_CODINT) | *required | zipCode (query) | string | Filtro 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 |
|
|
|
Dica |
---|
Expandir |
---|
| 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.codeId | string | Código de cadastro do prestador |
| *required | items.providerName | string | Nome do prestador |
| *required | items.localDescription | string | Descrição do prestador |
| *required | items.zipCode | string | CEP do prestador |
| *required | items.addressNumber | string | Número do endereço do prestador |
| *required | items.cityCode | string | Código da cidade do prestador |
| *required | items.city | string | Cidade do prestador |
| *required | items.state | string | Estado do prestador |
| *required | items.district | string | Bairro do prestador |
| *required | items.DDD | string | Código de área do telefone do prestador |
|
| items.telephone | string | Telefone do prestador |
|
| items.CNES | string | CNES do prestador |
|
|
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"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
} |
|
|
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 1 |
---|
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."
}
]
} |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo 2 |
---|
linenumbers | true |
---|
| {
"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ção | Descrição |
---|
Não se aplica | Não se aplica |
04. TELA Rede Credenciada
Principais Campos e Parâmetros
Campo | Descrição |
---|
BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO | Matricula do beneficiário no sistema |
BI3_CODIGO+BI3_VERSAO | Código do Produto Saúde no sistema |
BAQ_ESP | Có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)
04. TELA Rede de Atendimento
Principais Campos e Parâmetros
...
Card documentos |
---|
Informacao | Use esse box para destacar informações relevantes e/ou de destaque. |
---|
Titulo | IMPORTANTE! |
---|
|
...