@orchesty/connector-dropbox
v2.0.0
Published
[](https://www.npmjs.com/package/@orchesty/connector-dropbox) [](https://github.com/Orchesty/orchesty-nodejs-co
Readme
Dropbox Connector
An Orchesty connector for Dropbox, a cloud storage service that lets you store files online, sync them to all your devices, and share them easily.
Application Type
OAuth 2.0
This connector uses the Dropbox OAuth 2.0 authorization flow. After entering your credentials in Orchesty, you will be redirected to Dropbox to authorize access.
| Field | Description |
|---|---|
| client_id | OAuth application Client ID from the Dropbox App Console |
| client_secret | OAuth application Client Secret from the Dropbox App Console |
Components
| Class | Type | Description |
|---|---|---|
| DropboxUploadFile | Connector | Uploads a file to a specified Dropbox path via POST https://content.dropboxapi.com/2/files/upload |
Setup
Credentials
- Go to the Dropbox App Console and create a new app.
- Choose Scoped access and the appropriate access type (Full Dropbox or App folder).
- On the app settings page, note the App key (Client ID) and App secret (Client Secret).
- Under OAuth 2, add the Orchesty OAuth callback URL to the Redirect URIs list.
- In Orchesty, open the Dropbox application settings and fill in:
- Client Id — paste your App key
- Client Secret — paste your App secret
- Complete the OAuth authorization flow by clicking Authorize in Orchesty.
API Documentation
Dropbox HTTP API Reference: https://www.dropbox.com/developers/documentation/http
Installation & Usage
Install the package:
npm install @orchesty/connector-dropbox @orchesty/nodejs-sdk
# or
pnpm add @orchesty/connector-dropbox @orchesty/nodejs-sdkRegister the application and nodes in your Orchesty DI container:
import { container } from '@orchesty/nodejs-sdk';
import { OAuth2Provider } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Provider/OAuth2/OAuth2Provider';
import DropboxApplication from '@orchesty/connector-dropbox/dist/DropboxApplication';
import DropboxUploadFile from '@orchesty/connector-dropbox/dist/Connector/DropboxUploadFile';
const app = new DropboxApplication(container.get(OAuth2Provider));
container.setApplication(app);
container.setNode(new DropboxUploadFile(), app);License
This connector is released under the Apache License 2.0. See the LICENSE file for the full license text.
Contributing
Contributions are welcome! This connector is part of the open-source Orchesty Node.js Connectors monorepo.
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the Contributing to Connectors guide.
All contributions should include:
- Source code in
src/following the existing connector structure - Tests in
src/**/__tests__/withinput.json,mock.json, andoutput.jsonfixtures - An updated
CHANGELOG.mdentry
