Problem downloading documents from package with rest API
Thursday, March 25, 2021 at 11:43pmHello,
I have a problem downloading documents with the REST API. I use this request : https://apps.e-signlive.ca/api/packages/package_id/attachment/zip with the headers said in the documentation. I am able to download the document with angular, but when I try to open it I get "zip file invalid".
I attached my code in .png to this topic!
Here is a preview of what type of content my front-end is receiving : PK�#zRCapture.PNGup���Capture.PNG��peᶶ۶m�Ya��t�NVl�c�X�v��m۶��{������Ö�jz~5kÖ¬1��y���$��@��,'P�H�{�
�w;�&�w�&#V=At���\\Q �... etc..
I also tried the request in postman and I get this kind of response : PK���zR��������������Capture.PNGup����Capture.PNG��peᶶ۶m�Ya��t�NVl�c�X�v��m۶��{������֭�jz~5k֬1��y���$��@���,'P�H�{� ... etc...
I know that it's the zip file encoding, but I am not sure I am passing it correctly to my front-end or either to my blob object to download it.
Let me know if anyone know the answer to my problem! Thank you very much, I already tried a lot of things and still not working.. thanks!
- Guillaume
Reply to: Problem downloading documents from package with rest API
Friday, March 26, 2021 at 07:57amHi Guillaume,
Thanks for your post! Few questions to help understand the issue better:
-By "a preview of what type of content my front-end is receiving", do you mean the response your back end sends back to your front end, or what you saw when you opened the downloaded zip in notepad? Or are these two results the same?
-If the former - meaning probably your backend sends incorrectly encoded file - what if you directly hit the backend link in browser, or any other way to separately test your backend response?
Behind the scene, I've tested with Java Spring MVC backend + Fetch API to reproduce a similar flow, and it works for me. Below are the codes I used:
Java end:
@RequestMapping(value="/zip", produces="application/zip")
@CrossOrigin
public void zipFiles(HttpServletResponse response) throws IOException {
response.setStatus(HttpServletResponse.SC_OK);
response.addHeader("Content-Disposition", "attachment; filename=\"attachment.zip\"");
response.addHeader("Content-Type", "application/zip");
String API_KEY = "YkJmxxxZ3NBUg==";
String API_URL = "https://sandbox.esignlive.com/api";
EslClient eslClient = new EslClient(API_KEY, API_URL);
byte[] documentZip = eslClient.downloadZippedDocuments(new PackageId("Xs-rVmDCCHqiVLMyoaxwnceO8tI="));
response.setContentLength(documentZip.length);
OutputStream os = response.getOutputStream();
try {
os.write(documentZip , 0, documentZip.length);
} catch (Exception excp) {
//handle error
} finally {
os.close();
}
}
Front end:
fetch('http://localhost:8080/oss/zip')
.then(resp => {
const blob = resp.blob()
console.log(resp)
console.log(blob)
return blob
})
.then(blob => {
const url = window.URL.createObjectURL(blob);
const a = document.createElement('a');
a.style.display = 'none';
a.href = url;
// the filename you want
a.download = 'attachment.zip';
document.body.appendChild(a);
a.click();
window.URL.revokeObjectURL(url);
alert('your file has downloaded!');
})
.catch(() => alert('oh no!'));
During the test, I found only "const blob = resp.blob()" works for me, not "const blob = new Blob([resp],{type:'application/octet-stream'})". But I doubt it's the cause of issue for you.
Duo
Reply to: Problem downloading documents from package with rest API
Friday, March 26, 2021 at 08:58amUpdate:
Below Node JS code as backend also works for me:
var request = require('request');
var eslFunctions = module.exports =
{
downloadZip: function(req, res){
var options =
{
method: 'GET',
url: 'https://sandbox.esignlive.com/api/packages/Xs-rVmDCCHqiVLMyoaxwnceO8tI=/documents/zip',
headers:
{
accept: 'application/zip',
authorization: 'Basic xxxxxxxx'
}
};
request(options).on('response', function(response) {
res.set({
"Content-Type": "application/zip",
"Content-Disposition" : "attachment; filename=download.zip"
});
})
.pipe(res);
}
};
I also tried the code around "res.end(response.body)", but I found the downloaded zip can't be opened in winRAR and the downloaded size is larger than the actual size - not sure if it's the same behavior at your end.
Duo
Reply to: Update: Below Node JS code…
Friday, March 26, 2021 at 10:11amHi,
It worked! Apparently my front-end was not the problem, I used your NodeJs code with pipe(res). I guess the zip was not able to open because of the res.end..
Thank you so much again for your fast answer! :)
- Guillaume
Reply to: Problem downloading documents from package with rest API
Friday, March 26, 2021 at 10:12amGlad it works for you!
Duo