...

Objetivo

...

       O objetivo deste documento é esclarecer o funcionamento das APIs para busca, geração e download de um Relatório e também sobre o funcionamento do TReports via QueryString e Hyperlink.  Hoje o TReports conta com sua interface para listar, buscar, gerar e fazer o download dos relatórios produzidos, agora com a introdução às API's de Integração, será possivel que os produtos que se integrarem com o sistema tenham novas formar de utilizar as ferramentas disponibilizadas, tendo assim uma nova e melhor experiência para o usuário na linha de produto.

Preparo de Ambiente

...

     Para iniciar o uso das funcionalidades apresentadas, primeiro é necessário fazer a instalação do 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.

Via Interface

...

Utilizando a interface do sistema

Via API

...

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

Token

...

 Para realizar a integração com as APIs é necessário o envio do Access Token no campo Authorization do Header em todas as requisições e também é necessario fazer a verificação de disponibilidade da segurança através do produto.

GET: /api/security/v1/issuers

O retorno dessa requisição é o provider utilizado, displayName e o Issuer.

Busca de Relatório

...

É A busca de relatório é utilizada para encontrar o relatório desejado, sendo possível buscar todos os relatórios que o usuário tem permissão de acesso, seja sejam eles compartilhados via pasta ou via compartilhamento único. Assim como é feito na interface, a busca já pode ser realizada utilizando 3 caracteres para pesquisa, todos os relatórios que tiverem esses caracteres em comum serão retornados.

Exemplo:

Image Added

GET: /api/reports/v1/resources

• O filtro de relatórios é passado dessa forma ao final da URL:
  ?q={nome-do-Relatorio}
  
  

• 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 fazer uma busca baseada buscar o nome de relatórios baseados naquilo que foi digitado. escrito.

  A resposta dessa chamada retornará o ID do(s) relatório(s) pesquisado(s), o displayName que é o nome de criação, a description e o navigationFolderId que informa se aquele relatório pertence a alguma pasta, se pertencer é mostrado o ID da pasta, se não, é mostrado 'Null'.
  
  Exemplo de Resposta:

  Bloco de código
  theme RDark title Responde Body linenumbers true
  [ { "id": "1aa11111-1aa1-1aaa-1a1a-aa1aa1a11a11", "displayName": "Relatorio", "description": "Relatório utilizado para exemplificar", "navigationFolderId": 1 } ]

Busca de Parâmetros

...

Geração do Relatório

...

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.

...

• O 'generate?ttl=' é o tempo em minutos em que o documento gerado ficará disponível, vindo por padrão o valor 1440 e sendo o mínimo aceitável 1 minuto. 

• 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 retorno dessa requisição é o ID de geração que será utilizado para fazer o download do relatório desejado.

Download do Relatório

...

Para 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á utilizado preciso informar o ID da geração do relatório e o formato para download desejado.

...

Ao fim da requisição será possível visualizar o relatório no formato escolhido e fazer o seu download.

Hyperlink

...

Hyperlink é utilizado para fazer a visualização 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.

...

• A resposta é preenchida com as informações do relatório desejado e com as informações retiradas do token.

QueryString

A querystring no TReports é utilizada para visualizar o sistema sem que mostre seus menus.

• 
  

  Exemplo de resposta:

  Bloco de código
  theme RDark title Responde Body linenumbers true
  { "viewer": "

  Para fazer a utilização basta adicionar '?hidemenus=true' ao final da URL.
  Ex:

  http://localhost:7017/reportsV2/myreports

  /list?hidemenus=true

  /document-view/{reportId}?access_token={access_token}&refresh_token={refresh_token}&scope={scope}&token_type={token_type}&expires_in={expires_in}&hidemenus=true" }

QueryString

...

A querystring no TReports é utilizada para visualizar o sistema sem que mostre seus menus.

• Mesmo utilizando querystring é possível logar no sistema normalmente quando necessário.

...