Passar para o conteúdo principal
Todas as coleçõesIntegrações
Download do relatório via API
Download do relatório via API
Victor Serta avatar
Escrito por Victor Serta
Atualizado há mais de 5 anos

Através da integração com nossa API, é possível realizar o download automático dos relatórios de serviço que são gerados. Essa é uma opção muito útil se você deseja compartilhar os relatórios com os clientes sem precisar exportar manualmente e salvá-los em alguma nuvem compartilhada (ex.: Google Drive, Dropbox ou FTP) ou disponibilizar no seu próprio site.

Para isso, temos 2 opções que funcionam tanto para exportação PDF quanto Excel:

  • Opção 1: Solicitar para enviar o arquivo por e-mail

  • Opção 2: Solicitar para download

Esses 2 tipos de solicitações da API são assíncronos. No caso 1, é só realizar a chamada que assim que a exportação for concluída o e-mail será enviado automaticamente. Já o caso 2, é necessário primeiro solicitar e depois fazer uma consulta a cada 10/20 segundos para verificar se a exportação foi concluída para realizar o download.

Em nossa documentação da API temos um exemplo de como fazer isso na seção 09 Export_Request - 01 - List.

Veja abaixo como realizar a integração das 2 formas:

Exemplo opção 1 - Envio por e-mail

Request para solicitar 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]

      }

   }

}

Exemplo opção 2 - Download do arquivo

Request para solicitar exportação:
POST /export_requests

{
   "export_request":
   { 

      "account_id": 12345, 

      "send_method": "download", 

      "export_profile_id": 12345, 

      "filter": { 

         "form_fill_ids": [12345]

      }

   }

}

Request para verificar se exportação está pronta e pegar a url de download:
GET /export_requests/:id

Se estiver concluído, o atributo "status" será retornado com o valor "available". Basta fazer o download do arquivo através da url /export_requests/:id/download enviando os parâmetros de acesso do usuário. Isso é necessário por segurança para que o arquivo não possa ser visualizado por outras pessoas.

A url de download pode contar um redirecionamento para outra url (status code 302 Found). Dependendo da ferramenta ou biblioteca utilizada, é necessário realizar uma tratativa para utilizar a url retornada pelo 302 para realizar o download.

Respondeu à sua pergunta?