Histórico da Página
...
| API | Método | Rota | Documentação |
|---|---|---|---|
Beneficiário - Autorizações: Beneficiario/AutorizacoesPeriodo | GET | /Beneficiario/v1/AutorizacoesPeriodo | API Autorizações do Beneficiário por Período |
Beneficiário - Extrato de coparticipação: Beneficiario/PeriodosDemonstrativoCoparticipacao | GET | /Beneficiario/v1/PeriodosDemonstrativoCoparticipacao | API Extrato de Coparticipação do Beneficiário/Períodos |
Beneficiário - Extrato de coparticipação: Beneficiario/DemonstrativoCoparticipacao | GET | /Beneficiario/v1/DemonstrativoCoparticipacao | API Extrato de Coparticipação do Beneficiário |
Beneficiário - IRPF: Beneficiario/IRPFAnoBase | GET | /Beneficiario/v1/IRPFAnoBase | API Extrato de IRPF Ano Base |
Beneficiário - IRPF: Beneficiario/IRPF ** | GET | /Beneficiario/v1/IRPF | |
Beneficiário - 2ª via de boleto: Beneficiario/SegundaViaBoleto | GET | /Beneficiario/v1/SegundaViaBoleto | |
Beneficiário - 2ª via de boleto: Beneficiario/Titulos * | GET | /Beneficiario/v1/Titulos | |
Beneficiário - Histórico boletos: Beneficiario/TitulosLiquidados | GET | /Beneficiario/v1/TitulosLiquidados | API Beneficiário - Histórico de Boletos - Títulos Liquidados |
| Beneficiário - Extrato de Utilização: Beneficiario/PeriodosExtrato | GET | /Beneficiario/v1/PeriodosExtrato | API Extrato de Utilização do Beneficiário/Períodos |
| Beneficiário - Extrato de Utilização: Beneficiario/PeriodosExtrato | GET | /Beneficiario/v1/Extrato | API Extrato de Utilização do Beneficiário |
* Para Clientes que utilizam o Boletos padrão do GPSproduto, 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 para apresentação no demonstrativo do IRPF.
...
| Cabeçalho | Tipo de dados | Formato |
|---|---|---|
| String | 99999999999999999 | |
| String | 99999999999 |
| Aviso | ||
|---|---|---|
| ||
Retorno: Status 200, "DebugMessage": "1 - Necessario informar a carteira ou CPF do beneficiario;\\n;" → Faltou adicionar o header X-CPF ou X-Carteira com o formato String Retorno: Status: 400, "detailMessage": "Method not found" → Pode ocorrer pois não foi especificado o formato do header X-CPF ou X-Carteira Retorno: Status 404 → Revisar a URL que está sendo chamada. |
Autenticação:
As APIs são protegidas via Basic Authentication, utilizando um usuário e senha válidos do TOTVS Planos - Linha Datasul.
...
| 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==' |
...
| Aviso | ||
|---|---|---|
| ||
No exemplo acima, os parâmetros "-b cookie.txt -c cookie.txt " foram incluídos |
...
para manter os cookies, |
...
pois a autenticação padrão do JBOSS exige a gravação de cookies. Para contornar essa situação é que foi desenvolvido o contexto "/healthmanagementwebservices/rest/appUnimedBrasil", que deve ser utilizado apenas por operadoras com servidor de aplicação JBOSS afim de dispensar a gravação de cookies pelo client (no caso, o app). Operadoras que utilizem servidor de aplicação TOMCAT podem utilizar o contexto "/api/appUnimedBrasil" para a chamada das APIs com autenticação "basic auth" normalmente pois o novo framework não exige a gravação de cookies pelo client. |
| Aviso | ||
|---|---|---|
| ||
Caso utilizado o Postman informando o usuário e senha na aba authorization deve ser informado o usuário e senha sem converter pois o Postman converte e adiciona automaticamente o header conforme descrito na explicação a cima. |
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.
...
| 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 |
|
|
...
| View file | ||||
|---|---|---|---|---|
|
05. Clientes na 12.1.29 e 12.1.31 com JBOSS
É necessário atualizar o jar disponibilizado no pacote abaixo no seguinte caminho do JBOSS:
..\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.
| 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>
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas