CONTEÚDO
- Visão Geral
- APIs
- APIs Disponíveis
- Parâmetros
- Autenticação
- CPCs
- Expedição
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:
As APIs estão disponíveis em um dos seguintes contextos, dependendo do servidor de aplicação utilizado pelo cliente.
TOMCAT: http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil
JBOSS: http://<CONTEXTO-TOTVS:PORTA>/healthmanagementwebservices/rest/appUnimedBrasil
| API | Método | Rota | Documentação |
|---|---|---|---|
Cooperado - Extrato de Competências: Medico/ExtratoCompetencias | GET | /Medico/v1/ExtratoCompetencias | API Competências do Extrato de Contas - Médico |
Cooperado - Extrato: Medico/Extrato | GET | /Medico/v1/Extrato | API Extrato de Contas - Médico |
Cooperado - INSS: Medico/INSS | GET | /Medico/v1/INSS | API INSS - Médico |
Cooperado - Competências do INSS: Medico/INSSCompetencias | GET | /Medico/v1/INSSCompetencias | API Competências do INSS - Médico |
Cooperado - INSS em PDF: Medico/INSSPDF | GET | /Medico/v1/INSSPDF | API INSS PDF - Médico |
Cooperado - Imposto de Renda Pessoa Física: Medico/IRPF | GET | /Medico/v1/IRPF | API IRPF - Médico |
Cooperado - Imposto de Renda Pessoa Física Ano Base: Medico/IRPFAnoBase | GET | /Medico/v1/IRPFAnoBase | API Competências do IRPF - Médico |
Cooperado - Imposto de Renda Pessoa Física PDF: Medico/IRPFPDF | GET | /Medico/v1/IRPFPDF | API IRPF PDF - Médico |
| Cooperado - Produção Médica: Medico/Producao | GET | /Medico/v1/Producao | API Produção Médica - Médico |
Parâmetros:
As APIS aqui listadas recebem por parâmetro as informações pertinentes a rotina, todas elas recebem via Query Parameters
| API | Parâmetro | Tipo Parâmetro | Tipo de dados | Formato | Obrigatório? |
|---|---|---|---|---|---|
| Extrato | X-Matricula | Query Parameter | string | 99999999 | Sim |
| Extrato | competencia | Query Parameter | string | 99/9999 | Sim |
| INSS | X-Matricula | Query Parameter | string | 99999999 | Sim |
| INSS | competencia | Query Parameter | string | 99/9999 | Sim |
| INSS PDF | X-Matricula | Query Parameter | string | 99999999 | Sim |
| INSS PDF | competencia | Query Parameter | string | 99/9999 | Sim |
| IRPF | X-Matricula | Query Parameter | string | 99999999 | Sim |
| IRPF | ano | Query Parameter | string | 9999 | Sim |
| IRPF PDF | X-Matricula | Query Parameter | string | 99999999 | Sim |
| IRPF PDF | ano | Query Parameter | string | 9999 | Sim |
| Produção Médica | X-Matricula | Query Parameter | string | 99999999 | Sim |
| Produção Médica | dtInicio | Query Parameter | date | 99/99/9999 | Sim |
| Produção Médica | dtFim | Query Parameter | date | 99/99/9999 | Sim |
Situações comuns
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.
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==":
Request
curl -b cookie.txt -c cookie.txt --location --request GET 'http://<CONTEXTO-TOTVS:PORTA>/api/appUnimedBrasil/Medico/v1/IRPF?ano=2020' \ --header 'Authorization: Basic dXNlcjpwYXNzd29yZA=='
Importante
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.
Situações comuns
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.
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 |
|---|---|---|---|---|
Medico/ExtratoCompetencias |
| BOSAUEXTRATOCOMPETENCIAS |
| |
Medico/Extrato |
| BOSAUEXTRATOCONTAS |
| |
Medico/INSS |
| BOSAUINSS |
| |
Medico/INSSCompetencias |
| BOSAUINSSCOMPETENCIAS |
| |
Medico/INSSPDF |
| BOSAUINSSPDF |
| |
Medico/IRPF |
| BOSAUIRPF |
| |
Medico/IRPFAnoBase |
| BOSAUIRPFANOBASEMEDICO |
| |
Medico/IRPFPDF |
| BOSAUIRPFPDF |
| |
| Medico/Producao |
| BOSAUPRODUCAOMEDICA |
|
03. Expedição
API para integração com APP do Médico da Unimed do Brasil serão expedidos a partir da 12.1.34.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas