Como funciona o download de relatórios via API
A API do Produttivo permite automatizar a exportação dos relatórios de serviço gerados na plataforma, eliminando a necessidade de realizar esse processo manualmente.
Importante: o acesso à API do Produttivo está disponível apenas para clientes que possuem o plano Automação. Caso sua empresa utilize outro plano, será necessário contratar esse recurso para utilizar os endpoints apresentados neste artigo.
Essa funcionalidade é uma ótima opção para empresas que desejam compartilhar os relatórios com seus clientes sem precisar exportá-los manualmente e armazená-los em uma nuvem compartilhada, como Google Drive, Dropbox ou FTP, ou até mesmo disponibilizá-los em um site próprio.
Formas de exportação disponíveis
A API oferece duas opções de exportação, ambas compatíveis com os formatos PDF e Excel:
Solicitar o envio do arquivo por e-mail.
Solicitar o download do arquivo.
Como funciona o processamento da exportação
As duas opções de exportação utilizam processamento assíncrono.
Opção 1 – Envio por e-mail: basta realizar a solicitação. Assim que a exportação for concluída, o relatório será enviado automaticamente para o e-mail informado.
Opção 2 – Download: primeiro é necessário solicitar a exportação e, em seguida, consultar o status da solicitação a cada 10 ou 20 segundos até que o arquivo esteja disponível para download.
Na documentação da API, há um exemplo desse fluxo na seção 09 Export_Request - 01 - List.
A seguir, veja como realizar a integração utilizando as duas opções.
Opção 1: Enviar o relatório por e-mail
Solicitar a exportação
POST /export_requests
{
"export_request":
{
"account_id": 12345,
"send_method": "email",
"to_email": "teste@produttivo.com.br",
"export_profile_id": 12345,
"filter": {
"form_fill_ids": [12345]
}
}
}
Após o processamento da exportação, o relatório será enviado automaticamente para o e-mail informado na requisição.
Opção 2: Fazer o download do relatório
Solicitar a exportação
POST /export_requests
{
"export_request":
{
"account_id": 12345,
"send_method": "download",
"export_profile_id": 12345,
"filter": {
"form_fill_ids": [12345]
}
}
}
Verificar se a exportação foi concluída
Após solicitar a exportação, consulte o endpoint abaixo para verificar se o arquivo já está disponível e obter a URL de download.
GET /export_requests/:id
Quando a exportação for concluída, o atributo status será retornado com o valor available.
Fazer o download do arquivo
Após a exportação estar disponível, faça o download utilizando o endpoint:
GET /export_requests/:id/download
É necessário enviar os parâmetros de autenticação do usuário. Essa validação garante que apenas usuários autorizados possam acessar o arquivo, impedindo que ele seja visualizado por outras pessoas.
Atenção ao redirecionamento da URL de download
A URL de download pode retornar um redirecionamento HTTP 302 (Found).
Dependendo da linguagem, biblioteca ou ferramenta utilizada na integração, pode ser necessário tratar esse redirecionamento para utilizar a URL retornada pelo 302 e concluir o download do arquivo corretamente.
Pronto!
Agora você sabe como automatizar a exportação de relatórios via API do Produttivo, seja enviando os arquivos por e-mail ou disponibilizando-os para download em formato PDF ou Excel.
Sua integração está preparada para automatizar a geração e o compartilhamento de relatórios de forma segura e eficiente.
Precisa de ajuda?
Se tiver mais dúvidas sobre integração, pode contar com a gente.
É só clicar no botão laranja no canto inferior da tela para falar conosco pelo chat. Nosso time vai te ajudar no que for preciso! 😉