![[Note]](/media/com_docimport/admonition/note.png) | Note |
|---|---|
|
For use with the Upload to Dropbox (v2 API) post-processing engine. |
| Note |
|---|---|
|
This needs to only be done once, on the site which you will be using to host the OAuth2 helpers. It may be the same, or a different site than the one you are going to use the helpers on. |
Getting the Callback URL
Log into the backend of the site you want to host the OAuth2 helpers.
If you're on WordPress: go to Akeeba Backup.
Click on System Configuration.
Click on the OAuth2 Helpers tab.
Set OAuth2 Helper for Dropbox to Yes. You will see a blue note with three URLs below. Copy the Callback URL. It looks something like this (line breaks added for clarity):
https://www.example.com/index.php?view=oauth2&task=step2&format=raw&engine=dropbox
Copy this URL. Please remember that you need to use this URL verbatim in a later step.
Click on the Close button, without saving the component options.
Creating the API application
Log into your Dropbox account.
Go to https://www.dropbox.com/developers and click on .
Select Scoped access. Even if it's pre-selected for you, you still need to click on it to see the next step.
Select Full Dropbox.
Give your app a name.
Click on .
You are taken to your application's settings page.
![[Tip]](/media/com_docimport/admonition/tip.png) | Tip |
|---|---|
|
If you get lost, you can come back here by going to https://www.dropbox.com/developers/apps and clicking on your app's name. |
A Dropbox API app can be either in development or production status. In development mode there is a limit of up to 500 users, but you don't get pestered by app reviews. In production mode you can have a practically unlimited number of users, but you do have to complete app reviews. In the instructions below we assume that you will need less than 500 users, therefore you can remain in development mode.
Click on the button to raise the limit of users from 1 to 500.
Find Redirect URIs and paste the Callback URL you copied earlier. Then, click on the button next to it.
Click on the Permissions tab and select the following permissions:
-
files.metadata.write
-
files.content.write
-
files.content.read
-
team_info.read
-
team_data.member
-
team_data.team_space
Remember to click on the Submit link in the toast notification at the bottom of the window.
If you want, you can now set up some branding in the Branding tab.
Once you are done, go back to the Settings page.
Copy the App key. This is your Client ID.
Click on Show next to and copy the secret which appears. This is your Client Secret.
Enabling the custom OAuth2 Helper
Log into the backend of the site you want to host the OAuth2 helpers.
If you're on WordPress: go to Akeeba Backup.
Click on System Configuration.
Click on the OAuth2 Helpers tab.
Set OAuth2 Helper for Dropbox to Yes.
Paste the Client ID (App key) and Client Secret (App secret) you copied in the previous step into the same-named text boxes under the "OAuth2 Helper for Dropbox" section.
Click on .
| Note |
|---|---|
|
This needs to be done on every Akeeba Backup installation and backup profile which will be using this custom OAuth2 helper. The site using the OAuth2 helper does not necessarily have to be the same site you have set up the OAuth2 helper on. |
Getting the OAuth2 Helper and Refresh URLs
Log into the backend of the site which hosts the OAuth2 helpers.
If you're on WordPress: go to Akeeba Backup.
Click on System Configuration.
Click on the OAuth2 Helpers tab.
Find the OAuth2 Helper for Dropbox. You will see a blue note with three URLs below.
Copy the OAuth2 Helper URL and OAuth2 Refresh URL.
Telling Akeeba Backup to use a custom helper
Log into the backend of the site you will be taking the backups on. This may be different than the site which hosts the OAuth2 helpers.
If you're on WordPress: go to Akeeba Backup.
Select your backup profile, and click on Configuration.
Scroll down to the Post-processing Engine.
Select Upload to Dropbox
Change the OAuth2 Helper to Custom.
Paste the OAuth2 Helper URL and OAuth2 Refresh URL you copied in the previous step.
Click on Save. This is important! Until you click on Save, Akeeba Backup does not know you intend to use a custom OAuth2 Helper.
Authentication and setup
When the page reloads, click on Authentication - Start here.
| Tip |
|---|---|
|
You will know you are doing it right if the popup displays a warning letting you know what you are about to link it with an application which is not under the control of Akeeba Ltd. If you see the Dropbox interface, you missed the previous step (clicking on Save); in this case close the popup, click on Save, and then click on Authentication - Start here again. |
Go through the authentication.
At the end, you will see an Access Token and a Refresh Token. Copy them into the respective fields of your Akeeba Backup profile.