At line 3 changed 2 lines |
Dropbox supports external integration through an HTTP-based REST API. |
Generate an api key using : https://www.dropbox.com/developers/apps?_tk=pilot_lp&_ad=topbar4&_camp=myapps |
__Dropbox Integration Overview__: Dropbox REST API based integration. ([Documentation Link|https://www.dropbox.com/developers/documentation/http/documentation])\\ |
---- |
__⚠️ Proxy Configuration:__ If your server accesses the internet through a proxy, make sure to whitelist the following domains for DropBox Authentication and storage access: __api.dropboxapi.com__\\ |
---- |
__⚠️ Restrictions__:\\ |
• __No Resume Support for Uploads__: The Dropbox REST API does not natively support resumable uploads for partially transferred files in a way that is compatible with CrushFTP’s integration capabilities.\\ |
• __No Support for MDTM (File Modification Time) Changes__: |
The API does not allow direct modification of a file’s metadata, including the file modification time (mdtm). When files are created or updated, the modification time is automatically managed by Dropbox.\\ |
---- |
\\ |
Generate an __API Key__ using the __Dropbox Developer Portal__: [Dropbox My apps Link|https://www.dropbox.com/developers/apps?_tk=pilot_lp&_ad=topbar4&_camp=myapps]\\ |
\\ |
Click on the __Create App__ button:\\ |
__1.)__ Choose the appropriate API.\\ |
__2.)__ Choose the type of access:\\ |
- Full Dropbox (access to the entire Dropbox)\\ |
- App Folder (access only to an app-specific folder)\\ |
__3.)__ Name your app and click Create App.\\ |
__4.)__ Once the app is created, you’ll be redirected to the app settings page.\\ |
__5.)__ Under the Settings tab, you’ll find your App key (API key) and App secret.\\ |
\\ |
⚠️ The __Redirect URL__ must be added in the following format:\\ |
{{{ |
https://www.your.crushftp.com/?command=register_dropbox_api |
}}}\\ |
\\ |
It is important that the URL ends with __?command=register_dropbox_api__, as required by the Dropbox integration process.\\ |
\\ |
---- |
__⚠️ Note:__ For [CrushOIDC] Plugin the __Redirect URL__ must be added in the following format: |
{{{ |
https://www.your.crushftp.com/SSO_OIDC/ |
}}}\\ |
It is important that the URL ends with __/SSO_OIDC/__, as required by the [CrushOIDC] integration.\\ |
---- |
\\ |
[attachments|dropbox_api_registration.png]\\ |
\\ |
⚠️ Grant __Permissions__ for __Your Dropbox API__ Key. Click __Submit__ to save your changes.\\ |
[attachmentsApp permis|dropbox_permissions.png]\\ |
\\ |
[Dropbox Integration/personal_account_permissions.png]\\ |
\\ |
---- |
__Dropbox Business Account:__\\ |
\\ |
Grant the necessary permissions for team folders.\\ |
__⚠️ Important__: |
* Only users with the __Team Admin__ role can configure these settings.\\ |
* The __members.read__ permission is required for Dropbox Business accounts.\\ |
\\ |
[Dropbox Integration/business_acount_team_permissions.png]\\ |
\\ |
---- |
__DropBox Remote [VFS] settings__:\\ |
\\ |
Select the __DropBox__ item type and click the __Get Access Token__ button.\\ |
\\ |
[Dropbox Integration/dropbox_vfs_before_setup.png]\\ |
\\ |
__⚠️ Important__: To obtain the __Refresh Token__, the CrushFTP WebInterface’s host and port must match the __Redirect URL__ specified in the __Dropbox Developer Portal__. In our example, it was: __https://your.crushftp.domain.com/__\\ |
\\ |
Enter the __App Key__ , __App Secret__. Proceed with the authentication and authorization process.\\ |
__⚠️ Important__: Be sure to sign in with the __Dropbox Account__ that has the __necessary permissions__, as configured in the __Dropbox Developer Portal__ (mentioned above). This will automatically configure the __User name__ and __Password__.\\ |
\\ |
[Dropbox Integration/dropbox_appKey_appSecret_form.png]\\ |
\\ |
Grant access to CrushFTP in the form that appears after authentication. Review the requested permissions and click __Allow__ (or the equivalent button) to authorize CrushFTP to access the necessary resources.\\ |
\\ |
[Dropbox Integration/dropbox_allow_app.png]\\ |
\\ |
This will automatically configure the __User name__ and __Password__:\\ |
[attachments|dropbox_vfs_registration_finish.png]\\ |
\\ |
__⚠️ Dropbox Business Accounts__:\\ |
__Dropbox Business User Email__: Enter the __email address of the team member__ associated with the Dropbox Business account. All Team Folders will be accessed on behalf of this user.\\ |