Sync API SDKs

Dropbox offers native SDKs for iOS, OS X and Android. This page includes instructions on how to download and set up SDKs for each platform, as well as links to SDKs provided by the community for other environments.

Before building an app using the Sync API, you'll need to create an app with the App folder or File type permission in the App Console (Full Dropbox permission is not supported with the Sync API). Visit the developer guide for more information on the different types of permissions.

OS X SDK

Xcode 5 or later with the OS X development kit is required to build an OS X app using the Sync API. The Sync API requires OS X 10.7 or later.

Adding Dropbox.framework to your project

Once you've downloaded the Sync API OS X SDK, you'll need to add the framework to your project.

  1. Open your project in Xcode.
  2. Navigate to where you downloaded the SDK and drag the Dropbox.framework folder into your project in Xcode.
  3. Make sure Copy items ... is selected.
  4. Press the Finish button.

Now you want to make sure that the framework will be copied into your app bundle.

  1. Select the root of your project in the Project Navigator. This will show the project's configuration. Select the Build Phases tab which will show a list of Build Phases.
  2. If you do not see a Copy Files build phase, go to the menu bar and select Editor > Add Build Phase > Add Copy Files Build Phase.
  3. In the new build phase just added, set the destination to Frameworks.
  4. Click the + button and select the Dropbox.framework you just added.

Example apps

If you want to see the Sync API in action, check out the Examples directory in the SDK bundle. There you can find a simple note-taking app that uses the Sync API to save notes to Dropbox and alerts you if the notes are updated. This app will also sync notes with the notes example included in the SDKs for other platforms.

More info