...

       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 APIs de Integração, será possivel possível 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.

...

     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 Login no sistema para dar proceguimentoprosseguimento, feito isso, será necessário basta 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 a utilização é feita da seguinte formaUtilizamos o TReports para gerenciar recursos de maneira mais intuitiva e clara, podendo ser utilizado por qualquer nível de usuário devido sua amigável interface.

Via API

...

Ao utilizar a API a experiência é mais complexa porém mais rápida, o fluxo é feito em 6 requisições que podem ser encontradas em nosso Swagger, essas requisições são utilizadas para facilitar o uso de usuários que {espaço para completar}

...

Issuer

...

 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 necessário 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 aqueles que o usuário tem permissão de acesso, sejam eles criados pelo próprio usuário, compartilhados via pasta ou via compartilhamento único. Assim como é feito na interface, a busca já pode ser realizada utilizando ao enviar no mínimo 3 caracteres para pesquisa, todos os relatórios que tiverem esses caracteres em comum serão retornados.

Exemplo:
Image Removed

Image Added

Diferente da interface, na API não tem separação em contextos ('Meus Relatórios' e "Relatórios Compartilhados') então, o retorno é sempre todos os relatórios que contém no nome ou na descrição o filtro inserido.

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 buscar o nome de relatórios baseados naquilo que foi escrito.

  A resposta dessa chamada retornará um código HTTP 200 e 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 } ]

...

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 é um código HTTP 200 e informa o ID de geração que será utilizado para fazer o download do relatório desejado.

...