Getting started with the Connector SDK
Prerequisites
In order to use the Jitterbit Connector SDK and build a connector (either the example Dropbox connector or a custom connector of your own making), you'll need to complete these requirements:
-
Install the Java SE Development Kit 8.
Warning
Version 8 (linked) is required for successful Maven builds.
-
Install Maven. Version 3.9.9 is recommended.
- Install Postman (optional, but highly recommended).
- Install and register a Jitterbit private agent version 10.0 or higher.
- If running on Windows, we recommend a Windows private agent.
- If running on macOS, we recommend a Docker private agent.
- If running on Linux, either a Linux private agent or a Docker private agent.
- If using Docker:
- Install Docker (required to run a Docker agent).
- Download the Docker private agent image using
docker pull jitterbit/agent:latest
.
To build the example Dropbox connector, you'll also need to:
- Register with the Dropbox Developer Program, create an application, and retrieve its App key and Generated access token (covered in the Dropbox connector tutorial).
- Clone the example
jitterbit/dropbox-connector
GitHub repository.
A copy of the Connector SDK library is included as a component of the Dropbox connector and can be obtained by cloning the repository.
Dropbox connector tutorial
We recommend that all developers of a connector first build, run, and test the example Dropbox connector to work out any issues in your development process and settings.
To assist you, the Dropbox connector tutorial covers:
- Building the example Dropbox connector
- Registering the connector
- Editing the manifest
- Building the JAR file package
- Installing the connector
- Running the activities of the connector in different scenarios