For the integration to work with the Deputy, it needs to use an access token connected to a system administrator account.
1. Create a system administrator account in Deputy
Create a system administrator account in Deputy called AG API User (Do not delete).
Ensure that the credentials for this account are securely stored, allowing future team members to access the token user in accordance with your organisation's internal policies.
2. Create an access token
Login to Deputy on the AG API User (Do not delete) administrator account.
To create an access token, go to https://(deputy_prefix).au.deputy.com/exec/devapp/oauth_clients where “(deputy_prefix)” is replaced with the correct prefix for your organisation’s Deputy website.
If you are already on your organisation’s Deputy website, it may be easier to paste just the end part (/exec/devapp/oauth_clients) onto the end of your browser’s URL, making sure you get rid of any path that might interfere.
Example: 241c7203015542.au.deputy.com/exec/devapp/oauth_clients
Once you have navigated to the the right page, you will need to create a new access token. To do this click on ‘New OAuth Client’ in the top left corner of the webpage:
You will need to provide the following details:
- Name: Allara Integration
- Redirect Uri: https://(deputy_prefix).au.deputy.com/
Example: 241c7203015542.au.deputy.com
Now click on “Save This OAuth Client”:
Once that is created, click “Get An Access Token” at the top of the page.
The following screen will be displayed:
IMPORTANT: The access token will only be displayed in this popup box once. After pressing OK, it will never be shown again. Make sure it is copied or saved before closing the box.
Please copy and paste the token details, rather than taking a screenshot.
3. Securely share the access token with Allara Global
After the token has been created, make sure to copy the Access Token and share it with Allara Global. Please share the access token with Allara Global via Onetime Secret.
Along with the access token, please also provide your Deputy platform URL.