...
Informações |
---|
Documentação no swagger: Api publica para integração |
Para iniciar o uso das funcionalidades apresentadas, primeiro é necessário fazer a instalação do TReports.
Informações |
---|
Documentação referênte a instalação: Instalação TReports |
Com o TReports devidamente instalado e configurado, é necessário fazer o login no sistema para dar proceguimento, feito isso, será necessário configurar um Conector para fornecer os dados que serão utilizados no Relatório que futuramente será gerado.
...
Utilizando a interface do sistema
Ao utilizar a API o fluxo é feito em 6 requisições que podem ser encontradas em nosso Swagger, essas requisições são utilizadas para
Informações |
---|
Documentação no swagger: Api publica para integração |
...
...
...
...
...
...
...
...
...
...
GET: /api/reports/v1/resources
...
O filtro de Pastas é passado dessa forma ao final da URL:
?NavigationFolderId={ID-da-Pasta}
Informações |
---|
O filtro funciona assim como a própria busca via interface, ou seja, digitando no mínimo 3 caracteres já é possível buscar o nome de relatórios baseados naquilo que foi escrito. |
...
...
...
...
...
...
...
...
...
...
...
...
...
Para fazer a geração é necessário informar o ID do Relatório, o tempo que a geração ficara disponível para consultas e seu parâmetro, caso já tenha sido previamente cadastrado.
POST: /api/reports/v1/resources/{id-do-relatório}/generate?ttl=1440
...
Caso o relatório possua parâmetros cadastrados é necessário informar no body da requisição:
Bloco de código |
---|
{
"nome-do-parâmetro":"valor-desejado-do-parâmetro"
} |
...
O download nada mais é do que uma forma de salvar o relatório gerado localmente em um formato especifico desejado, para fazer o download será preciso informar o ID da geração do relatório e o formato para download desejado.
GET: /api/reports/v1/generated/{id-da-geração}/{formato}
Formatos disponíveis: PDF, XLS, XLSX, RTF, DOCX, MHT, HTML, TXT, CSV, JPEG e PNG.
Ao fim da requisição será possível visualizar o relatório no formato escolhido e fazer o seu download.
O Hyperlink permite que o produto integrador tenha acesso a um template de rota para acesso ao visualizador de um relatório sem utilizar o sistema como um todo.
GET: /api/reports/v1/hyperlinks
...
...
{
"viewer": "http://localhost:7017/reportsV2/myreports/document-view/{reportId}?access_token={access_token}&refresh_token={refresh_token}&scope={scope}&token_type={token_type}&expires_in={expires_in}&hidemenus=true"
}
A querystring no TReports é utilizada para visualizar o sistema sem que mostre seus menus.
...