Where a previous LTI integration has already been installed (e.g. LTI 1.1) you can skip to Step 11.
- 1: Go to Developer Keys
- 2: Add Developer Key
- 3: Input Key Settings
- 4: Turn On Tool
- 5: Note ID & Key
- 6: Login to PebblePad
- 7: Navigate to Global Admin
- 8: Select Integrations Tab
- 9: Input Setting Data
- 10: Authorise Tool
- 11 Share data with PebblePad Support
The API requires authentication from a user account with an administrator role. It is advisable to use a dedicated ‘Service Account’ and not a person's actual account. This will provide adequate security and ensure consistency of service, unaffected by people moving or leaving jobs. Follow Canvas docs to create a new admin user
1: Go to Developer Keys
Login to Canvas with the dedicated Service Account.
Within the Canvas Admin panel, navigate to Developer Keys in the sub-menu.
From the +Developer Key button, choose +API Key from the dropdown menu.
In the text areas, add the following information and Save.
|Owner email||[your email address]|
|- TAQAS Staging (all locations)||https://apptest.pebblepad.com/|
|- Australia (production)||https://v3.pebblepad.com.au/|
|- Canada (production)||https://app.pebblepad.ca/|
|- UK (production)||https://v3.pebblepad.co.uk/|
|- US (production)||https://pebblepad.com/|
Using the toggle, turn on the status of the Developer Key.
In the Details column, take note of the Client ID and use the Show Key button to reveal the Client Key. These details are needed for Step 9 below.
Go to your PebblePad install and login using an account with PebblePad Global Administrator permissions.
Use the Burger Menu to navigate to Additional Settings > Administration.
From the tab menu, select Integrations and from the sub menu beneath, Canvas.
Tick the field, Override the default PebblePad Client ID and Secret.
In the text areas, add the following information and Save (where you will be redirected back to Canvas)
|Canvas URL||Copy from address bar of your Canvas login screen (include /)|
|Client ID||Obtained in Step 5 (above)|
|Client Key||Obtained in Step 5 (above)|
- Login to Canvas using the same credentials as before and Authorise the tool from the confirmation modal.
- You'll be redirected back to Canvas set-up page in PebblePad Global Admin.
- The API tool is now configured.
If you have not already done so, download the .csv file below and complete with the required information. The Development ID can be located in Step 7 from Stage 2.
Follow this guide to upload to your PebblePad account and share the file with PebblePad Support.
Please ensure you update the Integration Journey Planner, marking stages 1-3 as complete. This will alert our PebblePad Implementation Engineer to action Super Admin settings. You will be contacted when completed to proceed to stage 4.