Índice

Objetivo

       O objetivo da API de Integração do TReports é promover uma nova e melhor forma de executar relatórios dentro do ERP TOTVS, permitindo a integração através de dois modelos de uso: acesso através de um visualizador externo ou a geração dos relatórios para download em diversos formatos.

Download de Arquivo

Neste modelo iremos demonstrar com o fluxo onde é solicitado a geração de um relatório para o sistema.

É apresentado um cenário em que o relatório já esteja previamente cadastrado, e para prosseguirmos com o fluxo é necessário que tenhamos a informação do identificador do relatório.

Iniciaremos o fluxo buscando pelo identificador do relatório (id) na API de busca de relatório onde seguiremos nas etapas de busca de parâmetros, solicitação de geração finalizando na API de download do arquivo gerado.

Busca de Relatório

A "busca de relatório" é uma API que retorna os relatórios cadastrados no sistema, é possível buscar apenas os relatórios em que o usuário tem permissão de acesso, sejam eles de sua própria criação, compartilhados via pasta ou compartilhamento único. Assim como na interface do sistema, a busca possui a funcionalidade de filtro onde é necessário enviar no mínimo 3 caracteres para pesquisa, dessa forma, os relatórios que tiverem esses caracteres em comum em seu nome de exibição ou descrição serão retornados. 

Detalhes da implementação são encontrados no endpoint abaixo:

Abaixo temos um exemplo da lista de relatórios retornados pela API, utilizaremos o relatório com id: a4127383-3229-420f-bd47-c795c2af5ebd como exemplo para dar continuidade em nosso fluxo de uso na próxima etapa.

[	
	{
        "id": "a4127383-3229-420f-bd47-c795c2af5ebd",
        "displayName": "Recibo de Fatura (JU203b) ",
        "description": "Recibo de Fatura (JU203b) - Grupo de Estudos",
        "navigationFolderId": 1
    },
    {
        "id": "cd767d3f-ec71-4c1a-8143-c6645dd8f63c",
        "displayName": "Recibo de Fatura\"",
        "description": "Recibo de Fatura\"",
        "navigationFolderId": null
    },
    {
        "id": "e30288af-6989-4a30-9792-3c7f5735db56",
        "displayName": "Relatorio sem fitro de casos",
        "description": null,
        "navigationFolderId": null
    }
]

Busca de Parâmetros 

É importante lembrar que um relatório pode conter parâmetros para sua geração, caso não tenha conhecimento da existência de parâmetros para o relatório selecionado, basta consultar a API abaixo.

A "busca de parâmetros" lista todos os parâmetros necessários para que o relatório posso ser executado, utilizaremos o valor do campo "name" de cada parâmetro para a próxima etapa.

[
    {
        "name": "pCodEscr",
        "displayName": "Código do Escritório",
        "type": "string",
        "multiValue": true
    },
    {
        "name": "pCodFatura",
        "displayName": "Código da Fatura",
        "type": "number",
        "multiValue": false
    },
    {
        "name": "pNomeSocio",
        "displayName": "Nome do Sócio da Fatura",
        "type": "string",
        "multiValue": false
    }
]

Busca de Sub relatórios

A "busca de sub relatórios" é uma API que retorna as informações dos sub relatórios vinculados a um relatório.

Detalhes da implementação são encontrados no endpoint abaixo:

Image Added

Abaixo um exemplo de retorno da busca de sub relatórios de um relatório:

[
    {
        "id": "e5483d4f-52b5-4e48-b17a-bcbbae5a7d7d",
        "displayName": "Sub Relatório 1",
        "subreports": 
			[
				{
			        "id": "e8d95844-b45c-4933-8643-ff518514fdfb",
        			"displayName": "Sub Relatório 1.1",
        			"subreports": []
                }  
			]
    },

     {
        "id": "2cd2aeda-9cce-4255-9de5-652476d39369",
        "displayName": "Sub Relatório 2",
        "subreports": []
    } 
]

Solicitação de Geração de um Arquivo

O endpoint "Solicitar Geração de um Arquivo" é uma API utilizada para solicitar a geração de um arquivo para o relatório escolhido, desde o início do fluxo coletamos informações importantes para utilização deste endpoint. Utilizaremos o identificador do relatório id: a4127383-3229-420f-bd47-c795c2af5ebd e o valor da propriedade "name" de cada parâmetro necessário para geração "pCodEscr", "pCodFatura" e "pNomeSocio".

É importante destacar que alguns parâmetros podem ser Multivalorados, ou seja, podem receber mais de um valor. Este tipo de parâmetro é reconhecido quando sua propriedade "multiValue" está definida como "true".

No caso do exemplo, é possível perceber que o parâmetro "pCodEscr" é multi valorado "multiValue: true", ou seja, o parâmetro recebe uma lista de valores.

Detalhes da implementação são encontrados no endpoint abaixo:

Cada solicitação é exclusiva de acordo com os parâmetros necessários, neste caso serão enviados no corpo da requisição "body" os parâmetros e seus respectivos valores conforme exemplo abaixo:

{
  "pCodEscr": ["SP001", "SP002"],
  "pCodFatura": 180,
  "pNomeSocio": "Isabelle Silva"
}

Caso a requisição seja feita corretamente, será apresentado como retorno o identificador de geração "generationId"  que utilizaremos na proxima etapa.

"3b845650-3972-49ae-9b5c-32f02423782b"

Download do Arquivo

Em nossa última etapa do fluxo utilizaremos o identificador da geração "3b845650-3972-49ae-9b5c-32f02423782b"  da etapa anterior para requerer o download do arquivo. 

Detalhes da implementação são encontrados no endpoint abaixo:

Este endpoint define o formato em que o arquivo será retornado. Os formatos disponíveis para download são:

Viewer Externo

Depois que o cadastro de um relatório foi feito, para que ele seja disparado em alguma extensão do ERP TOTVS, é preciso fazer a integração para ativar a geração do mesmo, sendo assim, é preciso utilizar o hyperlink que monta os links disponíveis para integração com visualizador.
Para iniciar o fluxo precisamos ter conhecimento do id de relatório que desejamos executar, caso não saiba essa informação, utilizaremos a busca de relatório para buscar essa informação.

Busca de Relatório

A "busca de relatório" é uma API que retorna os relatórios cadastrados no sistema, é possível buscar apenas os relatórios em que o usuário tem permissão de acesso, sejam eles de sua própria criação, compartilhados via pasta ou compartilhamento único. Assim como na interface do sistema, a busca possui a funcionalidade de filtro onde é necessário enviar no mínimo 3 caracteres para pesquisa, dessa forma, os relatórios que tiverem esses caracteres em comum em seu nome de exibição ou descrição serão retornados. 

Detalhes da implementação são encontrados no endpoint abaixo:

Abaixo temos um exemplo da lista de relatórios retornados pela API, utilizaremos o relatório com id: cd767d3f-ec71-4c1a-8143-c6645dd8f63c como exemplo para dar continuidade em nosso fluxo de uso na próxima etapa.

[	
	{
        "id": "a4127383-3229-420f-bd47-c795c2af5ebd",
        "displayName": "Recibo de Fatura (JU203b) ",
        "description": "Recibo de Fatura (JU203b) - Grupo de Estudos",
        "navigationFolderId": 1
    },
    {
        "id": "cd767d3f-ec71-4c1a-8143-c6645dd8f63c",
        "displayName": "Recibo de Fatura\"",
        "description": "Recibo de Fatura\"",
        "navigationFolderId": null
    },
]

Hyperlinks para integração

Os links retornados na requisição de Hyperlinks são utilizados para visualização de integrações feitas com o sistema, sendo uma delas a de Visualização, dessa forma, é possível abrir o TReports utilizando todos os seus recursos em um navegador.

O endpoint que utilizaremos para esse fluxo:

Para utilizar essa requisição vamos precisar de um ID de um relatório existente, nesse caso, utilizaremos o ID buscado na requisição de busca: cd767d3f-ec71-4c1a-8143-c6645dd8f63c

Os demais parâmetros podem ser informados por meio de QueryString ou diretamente na URL retornada. Esses parametros são as informações do token do usuário que irá abrir a interface da integração, essas informações são utilizadas para realizar contextualização e verificação de permissões.

Com a URL configurada vamos acessar um browser para visualização da mesma, é apresentado o relatório informado e após a conclusão da geração podem ser utilizados os recursos da inteface para fazer, por exemplo, o download do relatório.

Excluir relatório

É possível excluir um relatório via a API de integração através do endpoint abaixo:

Image Modified

O relatório será excluído apenas se o usuário que fizer a chamada for seu proprietário.