...

       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 APIs de Integração, será possível que os produtos que precisarem se integrarem com o sistema tenham novas formar de utilizar as ferramentas disponibilizadas, tendo assim formas de executar relatórios dentro do produto, tendo acesso a um visualizador e/ou ao relatório gerado em diversos formatos. Promovendo uma nova e melhor experiência para o usuário na da linha de produto ao precisar acessar suas informações por meio de relatórios.

     As APIs publicas estão disponíveis em qualquer instalação do TReports e suas operações estão documentadas via Swagger.

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 prosseguimento, feito isso, basta configurar um Conector para fornecer os dados que serão utilizados no Relatório que futuramente será gerado.

Viewer Externo

Geração de relatório para download 

...

Tendo um relatório previamente cadastrado

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}

...

Geração de relatório via visualizador

...

Tendo um

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 é necessário fazer a verificação de disponibilidade da segurança através do produto.

GET: /api/security/v1/issuers

...

[
  {
    "name": "parametro",
    "displayName": "parametro",
    "type": "string",
    "multiValue": true
  }
]

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

  Bloco de código
  theme Eclipse
  "3b845650-3972-49ae-9b5c-32f02423782b"

Download do Relatório

...

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}

...

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

Hyperlink

...

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 GET: /api/reports/v1/hyperlinks

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

  
  

  Exemplo de resposta:

  Bloco de código
  theme RDark title Responde Body linenumbers true
  { "viewer": "http://localhost:7017/reportsV2/myreports/document-view/{reportId}?access_token={access_tokenaccessToken}&refresh_token={refresh_tokenrefreshToken}&scope={scope}&token_type={token_typetokenType}&expires_in={expires_inexpiresIn}&hidemenus=true" }

  Pegando essa resposta e preenchendo corretamente, o usuário final pode utilizar esse link disponibilizado para permitir a visualização um relatório existente, ou seja, aquele que tiver acesso a esse viewer será logado automaticamente.
  Exemplo: 

QueryString

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

• Os parâmetros do template podem ser inseridos de acordo com a necessidade do produto, sendo preenchido via QueryString, dessa forma, as URLs retornadas no hyperlink já virão com os parâmetros preenchidos de acordo com as informações colocadas.

  Exemplo de URL enviando QueryString:

  Bloco de código
  theme Eclipse
  http://localhost:7017/api/reports/v1/hyperlinks?reportId=192f5b7a-01be-4592-8578-744bb84b9022&accessToken=MEU TOKEN&refreshToken=MEU REFRESH TOKEN&scope=default&tokenType=bearer&expiresIn=TEMPO DE EXPIRAÇÃO

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