Upload large files to Dropbox via HTTP API

2
votes

I am currently implementing an upload mechanism for files on my webserver into my Dropbox app directory.

As stated on the API docs, there is the /upload endpoint (https://www.dropbox.com/developers/documentation/http/documentation#files-upload) which accepts files up to 150MB in size. However I‘m dealing with images and videos with a potential size of up to 2GB.

Therefore I need to use the upload_session endpoints. There is an endpoint to start the session (https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start), to append data and to finish the session.

What currently is unclear to me is how to exactly use these endpoints. Do I have to split my file on my server into 150MB chunks (how would I do that with a video file?) and then upload the first chunk with /start, the next chunks with /append and the last one with /finish? Or can I just specify the file and the API somehow (??) does the splitting for me? Obviously not, but I somehow can‘t get my head around on how I should calculate, split and store the chunks on my webserver and not lose the session inbetween...

Any advice or further leading links are greatly appreciated. Thank you!

1
phpdropboxdropbox-api
You have to do the splitting yourself - otherwise there would be no point in providing this mechanism. Maybe you can find or create a wrapper on your server to abstract the splitting from your "move to dropbox" function - Kryptur
The above comment is correct; you need to split up the file into pieces yourself, of whatever size you want. (Up to 150 MB is technically supported, but you generally should use something smaller in practice, such as 8 MB.) Here's an example using the official Dropbox API v2 .NET SDK that shows the logic, as well as how one might read off the arbitrary chunk size. - Greg

1 Answers

4
votes

As Greg mentioned in the comments, you decide how to manage the "chunks" of the files. In addition to his .NET example, Dropbox has a good upload session implementation in the JavaScript upload example of the Dropbox API v2 JavaScript SDK.

At a high-level, you're splitting up the file into smaller sizes (aka "chunks") and passing those to the upload_session mechanism in a specific order. The upload mechanism has a few parts that need to be used in the following order:

  1. Call /files/upload_session/start. Use the resulting session_id as a parameter in the following methods so Dropbox knows which session you're interacting with.

  2. Incrementally pass each "chunk" of the file to /files/upload_session/append_v2. A couple things to be aware of:

    • The first call will return a cursor, which is used to iterate over the file's chunks in a specific order. It gets passed as a parameter in each consecutive call to this method (with the cursor being updated on every response).
    • The final call must include the property "close": true, which closes the session so it can be uploaded.

  3. Pass the final cursor (and commit info) to /files/upload_session/finish. If you see the new file metadata in the response, then you did it!!