This guide covers the API set-up process in the administration areas of both Moodle and PebblePad.
STEP-BY-STEP
- 1: Add External Service
- 2: Add Functions
- 3: Add Authorised User
- 4: Enable Protocols
- 5: Create Token
- 6: Add API to PebblePad global admin
- 7: Contact PebblePad
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.
- In Site Administration, follow Moodle's guide to Add a new user
1: Add External Service
- Login to Moodle with the dedicated Service Account
- Select Site Administration from the main menu
- Choose Server from the sub menu
- Scroll down the page and select Web Services
- Scroll down the page and select External Services
- Choose the Add link
- Complete the External service fields as follows
| SETTING | VALUE |
| Name | PebblePad LTI 1.3 |
| Short name | lti1p3 |
| Enabled | Check |
| Authorised users only | Check |
- Select the Add Service button to save and continue.
2: Add Functions
The Add functions page will open for the new PebblePad LTI 1.3 service.
- In the Name field, add these following functions one at a time (copy below and paste into the search field):
| core_enrol_get_enrolled_users |
| core_grades_update_grades |
| core_group_get_course_groups |
| core_group_get_groups |
| core_group_get_group_members |
| gradereport_user_get_grade_items |
| mod_lti_get_ltis_by_courses |
- Select the Add functions button to finish
3: Add Authorised User
- Use the breadcrumb menu to return to the External services page
- Scroll the page to locate the new PebblePad LTI service and select the Authorise Users link
- Find the new user (created prior to Step 1) in the Not Authorised list.
- Select the account and use the Add button to move them into the Authorised column
4: Enable Protocols
- Use the breadcrumb menu to return to the main Web Services page
- Scroll to Enable Protocols link and select to open
- Check that REST Protocol is present, has a version number, and is enabled
5: Create Token
- Use the breadcrumb menu to return to the main Web Services page
- Scroll to the bottom of the page to the Manage Tokens link and select
- Select the Create token button
- Complete the page as follows
| SETTING | VALUE |
| User | Search and select the authorised user (added in Step 4) |
| Service | PebblePad LTI 1.3 |
- Select the Save changes button to confirm
6: Add API to PebblePad global admin
- Login to your PebblePad install
- Use the Burger icon to open the sidebar menu
- Select Additional Settings and Administration
- From the global administration panel, select Integrations and below, Moodle
- Complete the page as follows:
| SETTING | VALUE |
|---|---|
| Moodle's location | The URL of the Moodle instance (must end with a / ) |
| Moodle's Service Name | lti1p3 (See step 1) |
| Username | Enter the username of the Authorised Account (See step 3) |
| Password | Enter the password of the Authorised Account (See step 3) |
- Scroll to the bottom of the page and Save
7: Contact PebblePad
If you haven't already, download the CSV file below and complete with the required information.
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.