CONTEÚDO
- Visão Geral
- Rota
- Parâmetros de Entrada
- Retorno
- Regras de Negócio Aplicadas
- Exemplo de Utilizaçã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.
A API INSS(Medico/INSSPDF) tem por objetivo retornar o demonstrativo de INSS do médico no formato PDF convertido em BASE64.
A API foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil:
a. Rota
/Medico/v1/Extrato
b. Parâmetros de Entrada
Esta API deve receber os seguintes parâmetros via header ou via query parameters:
Parâmetro | Tipo de Parâmetro | Tipo de dados | Formato | Obrigatório? |
---|---|---|---|---|
header | Integer | 99999999 | Sim | |
competencia | query | String | MM/AAAA | Sim |
c. Retorno
O objeto Json de retorno da API possui a seguinte estrutura:
{ "Result": "Domínio: 0 = Erro na execução do serviço, 1 = Processamento Ok", "Message": "Mensagem de retorno que deverá ser exibida ao usuário (obrigatória em caso de erro, ou seja, Result = 0)", "Data": { "nome": "Nome do arquivo", "file64": "String do arquivo codificado em Base64", "mimeType": "Tipo do arquivo: application/pdf" }, "DebugMessage": "string" }
03. REGRAS DE NEGÓCIO APLICADAS
A API retorna um documento (em PDF) contendo o demonstrativo de INSS do médico.
04. EXEMPLO DE UTILIZAÇÃO
Realizada uma requisição na API utilizando a matrícula e a competência conforme abaixo:
Parâmetro | Valor |
---|---|
competencia | 07/2016 |
00031921 |
{ "Result": 1, "Data": { "file64": "JVBERi0xLjUKJeLjz9MKNCAwIG9iago8PC9UeXBlL1hPYmplY3QvQ29sb3JTcGFjZS9EZXZpY2VHcmF5L1N1YnR5cGUvSW1hZ2UvQml0c1BlckNvbXBvbmVudCA4L1dpZHRoIDEzMS9MZW5ndGggMTI2OS9IZWlnaHQgNTIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJztmHtQVFUcx==", "nome": "INSS20218457943.pdf", "mimeType": "application/pdf" }, "DebugMessage": "", "Message": "" }
Ao decodificar a BASE64 para PDF, obtemos o seguinte resultado:
Por fim, os registros aqui listados podem ser validados pelo programa "Demonstrativo INSS" do módulo Autorizador WEB