Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

APIMétodoRota

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/Titulositulos *

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

* 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.

Parâmetros:

Algumas dessas APIs esperam receber alguns parâmetros via header ou via query parameters.

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 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:

...