CONTEÚDO

  1. Visão Geral
  2. APIs
    1. APIs Disponíveis
    2. Parâmetros
    3. Autenticação
  3. CPCs

01. VISÃO GERAL

O TOTVS Saúde Planos oferece uma série de APIs para integração com o APP da Unimed Brasil.

As APIs foram desenvolvidas seguindo as definições disponibilizadas no Swagger da Unimed Brasil. 

02. APIs 

APIs disponíveis:

APIMétodoRota

Beneficiário - Autorizações: Autorizações Período

GET

http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/AutorizacoesPeriodo

Beneficiário - Extrato de coparticipação: Beneficiario/PeriodosDemonstrativoCoparticipacao

GET

http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/PeriodosDemonstrativoCoparticipacao

Beneficiário - Extrato de coparticipação: Demonstrativo Coparticipação

GET

http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/DemonstrativoCoparticipacao

Beneficiário - IRPF: Ano Base

GET

http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/IRPFAnoBase

Beneficiário - IRPF: IRPF

GET

http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/IRPF

Beneficiário - 2ª via de boleto: Beneficiario/SegundaViaBoleto

GET

http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/SegundaViaBoleto

Beneficiário - 2ª via de boleto: Beneficiario/Títulos

GET

http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/titulos

Beneficiário - Histórico boletos: Títulos Liquidados

GET

http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/TitulosLiquidados

Parâmetros:

APIParâmetroTipo ParâmetroTipo de dadosFormatoObrigatório?
AutorizacoesPeriododtInicioQuery Parameterstring dd/mm/aaaaSim
AutorizacoesPeriododtFimQuery Parameterstring dd/mm/aaaaSim
DemonstrativoCoparticipacaoperiodoIdQuery Parameterstring*Sim
IRPFanoQuery Parameterinteger9999Sim
SegundaViaBoletotituloIdQuery Parameterstring*Sim

* O formato desses valores é definido pelo retorno das APIs PeriodosDemonstrativoCoparticipacao, Ano Base e Títulos, que retornam os IDs utilizados para alimentar esses parâmetros.

Além desses parâmetros, todas as APIs exigem que seja informado ao menos um dos cabeçalhos abaixo no header da requisição:

CabeçalhoTipo de dadosFormato
String99999999999999999
String99999999999

Autenticação:

As APIs são protegidas via Basic Authentication, utilizando um usuário e senha válidos do TOTVS Planos - Linha Datasul. 

Para utilizar as APIs, o usuário e senha devem ser enviados em base64 no formato USUARIO:SENHA no cabeçalho de autenticação do tipo Basic.

Exemplo de uma requisição requisição com Basic Authentication onde o usuário é "super" e a senha "super", resultando em um base64  = "c3VwZXI6c3VwZXI=":

curl --location --request GET 'http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/IRPF?ano=2020' \
--header 'x-CPF: 98765432100' \
--header 'Authorization: Basic c3VwZXI6c3VwZXI='


03. CPCs

Cada API possui dois pontos de CPC. Um no início do processo que permite sobrescrever total ou parcialmente a lógica do produto padrão e outro ao final do processo que permite fazer ajustes nos dados antes de enviar a resposta da requisição.

Para utilizar as CPCs, primeiramente deverá importar o arquivo DZLIBPRX.D (download) através do menu "Importação CPC" (HCG0210Z). Após, habilitar os pontos de CPC desejados através do menu "Manutenção CPC" (HTE0110L) e desenvolver a lógica da cada um dos pontos de chamada no programa da CPC correspondente. 


Abaixo a listagem das CPCs disponíveis juntamente com o manual de cada ponto de CPC e um programa de exemplo.

APIPontos de CPCNome Rotina da CPCManual CPCModelo de CPC 
Beneficiario/SegundaViaBoleto
  • ANTES-PROCESSO
  • DEPOIS-PROCESSO



Beneficiario/PeriodosDemonstrativoCoparticipacao
  • ANTES-PROCESSO
  • DEPOIS-PROCESSO
BOSAUPERIDEMONSTCOPART

External link symbol free icon

botão download grátis ícone




<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>