Using the API to generate zip file downloads for folders from within a page?

Hi,

Using the Canvas API is it possible to somehow create a link that would allow a student to download a zipped version of a folder in the files section from a page?

I was looking here: Content Exports - Canvas LMS REST API Documentation

what would be the best way to be able to make an API call from within a page? Is this even possible?

Basically I have a course where users have to navigate and download lots of files in lots of sections. Manually creating and linking to zips would be a nightmare to manage in terms of keeping up to date with changes etc... Plus just why do something manually if you can automate it.

Has anybody else had a similar problem or could offer a better solution?

Many thanks,

Lawrence

@gmiroshnikov ‌

Find more posts tagged with

Open API

Accepted answers

All comments

Robert

I'm not sure you can zip files with the API.

Your students can try File Sync and https://canvasfilesync.com

James

@lchallen ,

Getting a link like this to actually do anything would require adding JavaScript to the page, which would have to be done through the custom global JavaScript in the Theme Editor.

You can make read-only API calls directly from Canvas. For example, if I go into a content page and add a link to /api/v1/courses/1234/users, then clicking that link authenticates as the user viewing the page and shows the list of users (if they can see it) for the course.

That said, it's also going to come with a while(1); in front of it and just return JSON code. It will not give you a downloadable ZIP file.

The content export routine you're looking at is a POST, not a GET, so you wouldn't be able to call it directly from within a page. Any HTML necessary to do that would get blocked by the Canvas HTML Editor Whitelist.

Also, it takes some time to prepare the list of files as some may be very large. It might not even start right away based on how busy the system is doing other things. The documentation says that you would need to monitor the progress of the job. Those kinds of things are not suitable for a situation where someone is sitting, waiting on the page -- especially a student. It may be okay in most cases, but it's something to consider.

All of the stuff mentioned that would be involved in that would make it unsuitable for generating a link or button within the page that zipped it while the student waited.

You might be able to write an LTI that would do it. It could scan for the latest versions of the files and zip them up. You could, possibly, provide the link for just the instructor that would trigger an update of a zip file in an offline process. Again, downloading all the files, zipping them, re-uploading that is not something that can reliably occur in real-time.

If this is just for a single course, then it really is going to be easiest for the instructor to mirror the Canvas structure on a local computer and update the zip files when the instructor changes one of the files. This could be automated, even to the point of using a cURL to upload the updated zip file to Canvas. WebDAV would make that easier and it has been suggested a couple of times, someone even asked about an integration with Dreamweaver once, but all of the feature requests didn't gain enough momentum and are currently in cold storage.

You only need to link to the zip file once, though. When you re-upload the zip file containing all of the files, then you replace the existing once and the link is still good.

Any solution that you try to come up with automating the process within Canvas is going to be a lot of work. For just one or two courses, you have to weigh the return on investment and it's easier to just maintain the zip files separately. If you don't need access to all of the individual files, it would be easier for the students to just download a zip rather. That would also be less for the instructor to upload. Of course, if these multiple files contain content needs to be displayed within Canvas, then keeping just the zip file isn't an option.

Unanswered Questions

Concluded Course and Canvas Data Services
Canvas Data Services sent out an alert that a course was concluded (because the course was concluded) and the status of each user in the UI is set to complete, however, the enrollments API endpoint shows the status of each user in the course as active. Is this a common issue? Have I misinterpreted how the individual…
Canvas Media Question
How can one track Canvas Media use without having the reports available from Canvas Studio? Checking API endpoints and the Data 2 schema, there do not seem to be dedicated Canvas Media endpoints. Am I missing some? A method I've considered is using the body field of the wiki_pages table, as this contains the html code of…
Canvas Catalog API - Completed Certificates
Hello, I'm trying to utilize an API call to pull completed certificates and was hoping to download and store the certs as a backup. I can successfully run the API call but it will not allow me to view the certificate unless I access the URL while signed into an account where it's "my" cert. Is there a permissions setting…
UI for weekly progression idea
UI for weekly progression idea that rest in the Schedule tab of the **K-12 UI** of Canvas it's incomplete and I really would not take it and push it into instance but I am going to post it here because in the past people like @James && @robotcars || @Steve_25 have had terrific input in the past... maybe w/their eyes and…
Canvas integration with React + Flask webapp - initially for authenticaiton
I have a new React + Flask webapp. It has its own login for users to start using the app. I have added this as an external tool in Canvas. What I want initially is to see of canvas users can start using the webapp without having to login if they click on the external tool link in a canvas course. I have 2 methods…