License:[MIT](License.txt)

You can also download the Java SDK JAR and and its required dependencies directly from the[latest release page](https://github.com/dropbox/dropbox-sdk-java/releases/latest). Note that the distribution artifacts on the releases pages do not contain optional dependencies.

You need a Dropbox API key to make API requests.

* Go to:[https://www.dropbox.com/developers/apps](https://www.dropbox.com/developers/apps)

* If you've already registered an app, click on the "Options" link to see the app's API key and secret.

* Otherwise, click "Create an app" to register an app. Choose "Dropbox API app", then "Files and datastores", then "Yes" or "No"[depending on your needs](https://www.dropbox.com/developers/reference#permissions).

A good way to start using the Java SDK is to follow this quick tutorial. Just make sure you have the the Java SDK[installed](/developers/documentation/java#install) first!

Save the API key to a JSON file called, say, "test.app":

To use the Dropbox API, you'll need to register a new app in the[App Console](/developers/apps). Select Dropbox API app and choose your app's permission. You'll need to use the app key created with this app to access API v2.

In order to make calls to the API, you'll need an instance of the Dropbox object. To instantiate, pass in the access token for the account you want to link. (Tip: You can[generate an access token](https://blogs.dropbox.com/developers/2014/05/generate-an-access-token-for-your-own-account/) for your own account through the[App Console](https://www.dropbox.com/developers/apps)).

importcom.dropbox.core.DbxRequestConfig;

importcom.dropbox.core.v2.DbxClientV2;

publicclassMain {

privatestaticfinalStringACCESS_TOKEN="<ACCESS TOKEN>";

publicstaticvoidmain(Stringargs[])throwsDbxException {

DbxRequestConfig config=newDbxRequestConfig("dropbox/java-tutorial","en_US");

DbxClientV2 client=newDbxClientV2(config,ACCESS_TOKEN);

}

}

Test it out to make sure you've linked the right account:

FullAccount account= client.users().getCurrentAccount();

System.out.println(account.getName().getDisplayName());

You can use the Dropbox object you instantiated above to make API calls. Try out a request to list the contents of a folder.

ListFolderResult result= client.files().listFolder("");

while (true) {

for (Metadata metadata: result.getEntries()) {

System.out.println(metadata.getPathLower());

}

if (!result.getHasMore()) {

break;

}

result= client.files().listFolderContinue(result.getCursor());

}

Try uploading a file to your Dropbox.

try (InputStream in=newFileInputStream("test.txt")) {

FileMetadata metadata= client.files().uploadBuilder("/test.txt")

.uploadAndFinish(in);

}

importcom.dropbox.core.DbxException;

importcom.dropbox.core.DbxRequestConfig;

importcom.dropbox.core.v2.DbxClientV2;

importcom.dropbox.core.v2.files.FileMetadata;

importcom.dropbox.core.v2.files.ListFolderResult;

importcom.dropbox.core.v2.files.Metadata;

importcom.dropbox.core.v2.users.FullAccount;

importjava.util.List;

importjava.io.FileInputStream;

importjava.io.InputStream;

importjava.io.IOException;

publicclassMain {

privatestaticfinalStringACCESS_TOKEN="<ACCESS TOKEN>";

publicstaticvoidmain(Stringargs[])throwsDbxException,IOException {

DbxRequestConfig config=newDbxRequestConfig("dropbox/java-tutorial","en_US");

DbxClientV2 client=newDbxClientV2(config,ACCESS_TOKEN);

FullAccount account= client.users().getCurrentAccount();

System.out.println(account.getName().getDisplayName());

ListFolderResult result= client.files().listFolder("");

while (true) {

for (Metadata metadata: result.getEntries()) {

System.out.println(metadata.getPathLower());

}

if (!result.getHasMore()) {

break;

}

result= client.files().listFolderContinue(result.getCursor());

}

try (InputStream in=newFileInputStream("test.txt")) {

FileMetadata metadata= client.files().uploadBuilder("/test.txt")

.uploadAndFinish(in);

}

}

}

Before your appcanaccess a Dropbox user's files, the user must authorize your application using OAuth 2. Successfully completing this authorization flow gives you an_access token_ for the user's Dropbox account, which grants you the ability to make Dropbox API calls to access their files.

Some more complete examplescanbe found here:

* Example for a simple web app:[Web File Browser example](examples/web-file-browser/src/main/java/com/dropbox/core/examples/web_file_browser/DropboxAuth.java)

* Example for an Android app:[Android example](examples/android/src/main/java/com/dropbox/core/examples/android/UserActivity.java)

* Example for a command-line tool:[Command-Line Authorization example](examples/authorize/src/main/java/com/dropbox/core/examples/authorize/Main.java)

Once you have an access token, create a[`DbxClientV2`](https://dropbox.github.io/dropbox-sdk-java/api-docs/v2.1.x/com/dropbox/core/v2/DbxClientV2.html) and start making API calls.

To try out running this examples, please follow the instructions below.

You only need to perform the authorization process once per user. Once you have an access token for a user, save it somewhere persistent, like in a database. The next time that user visits your app's, you can skip the authorization process and go straight to creating a`DbxClientV2` and making API calls.

Save your Dropbox API key to a JSON file called, say, "test.app":

The output will be in "build/".

1. Follow the instructions in the "Build from source" section above.

2. Save your Dropbox API key in a file called "test.app". See:[Get a Dropbox API key](#get-a-dropbox-api-key), above.

3. Compile and install the SDK into your local maven repo:`./gradlew install`

4. To compile all the examples:`(cd examples/ && ./gradlew classes`

5. To compile just one example:`(cd examples/ && ./gradlew :<example-name>:classes`

This examples runs through the OAuth 2 authorization flow.

This produces a file named "test.auth" that has the access token. This file can be passed in to the other examples.

A simple example that fetches and displays information about the account associated with the access token.

(You must first generate "test.auth" using the "authorize" example above.)

An example of how to watch for changes in a Dropbox directory.

(You must first generate "test.auth" using the "authorize" example above.)

The example from our[online tutorial](https://www.dropbox.com/developers/documentation/java#tutorial). Unlike the other examples, this example is not meant to be run without modification.

Uploads a file to Dropbox. The example includes regular and chunked file uploads.

(You must first generate "test.auth" using the "authorize" example above.)

A tiny web app that runs through the OAuth 2 authorization flow and then uses Dropbox API calls to let the user browse their Dropbox files.