Histórico da Página
CONTEÚDO
- Visão Geral
- APIs
- APIs Disponíveis
- Parâmetros
- Autenticação
- CPCs
- Homologação 12.1.26
01. VISÃO GERAL
O TOTVS Saúde Planos (Linha Datasul) 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:
| API | Método | Rota |
|---|---|---|
Beneficiário - Autorizações: Beneficiario/AutorizacoesPeriodo | 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: Beneficiario/DemonstrativoCoparticipacao | GET | http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/DemonstrativoCoparticipacao |
Beneficiário - IRPF: Beneficiario/IRPFAnoBase | GET | http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/IRPFAnoBase |
Beneficiário - IRPF: Beneficiario/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/Titulos * | GET | http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/Titulos |
Beneficiário - Histórico boletos: Beneficiario/TitulosLiquidados | GET | http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/TitulosLiquidados |
| Beneficiário - Extrato de Utilização: Beneficiario/PeriodosExtrato | GET | http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/PeriodosExtrato |
| Beneficiário - Extrato de Utilização: Beneficiario/PeriodosExtrato | GET | http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/Extrato |
* Para Clientes que utilizam o Boletos do GPS, o atributo linhaDigitavel só será retornado para títulos cujo lote de boletos já tenha sido gerado (processo de geração) e o download (momento em que é criado o PDF ou TXT) já tenha sido finalizado.
**Para apresentar esse demonstrativo são utilizados os dados enviados na DMED. Dessa forma, sempre que for gerado o arquivo da DMED será carregada uma tabela com a competência e valores a apresentar no demonstrativo do IRPF.
Parâmetros:
Algumas dessas APIs esperam receber alguns parâmetros via header ou via query parameters.
| API | Parâmetro | Tipo Parâmetro | Tipo de dados | Formato | Obrigatório? |
|---|---|---|---|---|---|
| AutorizacoesPeriodo | dtInicio | Query Parameter | string | dd/mm/aaaa | Sim |
| AutorizacoesPeriodo | dtFim | Query Parameter | string | dd/mm/aaaa | Sim |
| DemonstrativoCoparticipacao | periodoId | Query Parameter | string | * | Sim |
| IRPF | ano | Query Parameter | integer | 9999 | Sim |
| SegundaViaBoleto | tituloId | Query Parameter | string | * | Sim |
| Extrato | periodoId | Query Parameter | string | * | Sim |
* O formato desses valores é definido pelo retorno das APIs PeriodosDemonstrativoCoparticipacao 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çalho | Tipo de dados | Formato |
|---|---|---|
| String | 99999999999999999 | |
| String | 99999999999 |
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 é "user" e a senha "password", resultando em um base64 = "dXNlcjpwYXNzd29yZA==":
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl -b cookie.txt -c cookie.txt --location --request GET 'http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Beneficiario/v1/IRPF?ano=2020' \ --header 'x-CPF: 98765432100' \ --header 'Authorization: Basic dXNlcjpwYXNzd29yZA==' |
Importante: é necessário que a aplicação que faz a requisição guarde os cookies da sessão para que a autenticação funcione. No exemplo acima, os parâmetros "-b cookie.txt -c cookie.txt " foram incluídos justamente para manter os cookies, tornando possível o login.
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.
| API | Pontos de CPC | Nome Rotina da CPC | Manual CPC | Modelo de CPC |
|---|---|---|---|---|
Beneficiario/AutorizacoesPeriodo |
| BOSAUAUTORIZACOESPERIODO | ||
Beneficiario/PeriodosDemonstrativoCoparticipacao |
| BOSAUPERIDEMONSTCOPART | ||
Beneficiario/DemonstrativoCoparticipacao |
| BOSAUDEMONSCOPART | ||
Beneficiario/IRPFAnoBase |
| BOSAUIRPFANOBASE | ||
Beneficiario/IRPF |
| BOSAUIRPF | ||
Beneficiario/SegundaViaBoleto |
| BOSAUSEGUNDAVIABOLETO | ||
Beneficiario/Titulos |
| BOSAUTITULOS | ||
Beneficiario/TitulosLiquidados |
| BOSAUTITULOSLIQUIDADOS | ||
| Beneficiario/PeriodosExtrato |
| BOSAUPERIODOSEXTRATO | ||
| Beneficiario/Extrato |
| BOSAUEXTRATO |
04. JBoss
Para que a autenticação com o app funcione corretamente no JBoss é necessário atualizar as URLs conforme abaixo:
http://<CONTEXTO-TOTVS:PORTA>healthmanagementwebservices/rest/appUnimedBrasil/<servicço>
| Informações | ||
|---|---|---|
| ||
http://<CONTEXTO-TOTVS:PORTA>healthmanagementwebservices/rest/appUnimedBrasil/Beneficiario/v1/AutorizacoesPeriodo http://<CONTEXTO-TOTVS:PORTA>healthmanagementwebservices/rest/appUnimedBrasil/Beneficiario/v1/PeriodosDemonstrativoCoparticipacao http://<CONTEXTO-TOTVS:PORTA>healthmanagementwebservices/rest/appUnimedBrasil/Beneficiario/v1/DemonstrativoCoparticipacao |
05. Homologação 12.1.26
Abaixo os programas disponíveis para Homologação na 12.1.26. É necessário estar atualizado com o último patch disponível no console oficial de atualização.
Observação: Para a homologação do item IRPF é necessário aplicar, momentaneamente, o delta em uma tabela especifica e realizar a compilação dos programas .p. Com a aplicação da tabela liberada antecipadamente em um banco específico, ao ocorrer a expedição da tabela oficialmente não acontecerá erros no console oficial de atualização.
É necessário atualizar o jar datasul-hgp-webservices-12.1.26-SNAPSHOT.jar no caminho:
..\ServidorAplicacao\jboss-4.2.3.GA\server\<INSTANCE>\deploy\datasul-byyou-<VERSÂO>-SNAPSHOT.ear\datasul-hgp-webservices-<VERSÂO>-SNAPSHOT.war\WEB-INF\lib
Também é necessário reiniciar a aplicação para que as alterações tenham efeito.
| View file | ||||
|---|---|---|---|---|
|
| HTML |
|---|
<!-- 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>
|