1-888-257-2278 Go to YuJa
  1. YuJa Help Center
  2. YuJa Verity for Test Proctoring
  3. Verity Settings
  4. Institution Settings

Adding the Moodle API with Verity

Avatar
YuJa Product Support
  • Updated

After integrating Moodle with Verity, admins can add the Moodle API to Verity. Adding the API will ensure assessment names are synced between Moodle and Verity. 

Creating an External Service in Moodle

You will need to create an external service that includes the required API functions.

  1. Log in to Moodle as an administrator and click Site administration from the navigation menu.
    An image of the Side administration page highlighting the Site administration option in the navigation menu.
  2. Click Server and select External services from Web services.
    An image of the Side administration page highlighting the Server and External Services option.
  3. Under Custom services, click Add.
    An image of the External services page highlighting the Add button.
  4. Enter the Name of your integration (e.g. Verity) and, check the Enabled checkbox, then click Add service.
    An image of the External services page highlighting the Name field, the Enabled option, and Add service button.
  5. On the next page, click Add functions.
    An image of the Server page highlighting the Add functions button.
    Note: Click Continue if you're not properly redirected to the add functions page.
    An error page highlighting the Continue button.
  6. In the Name drop-down list, search for the following API functions and click each of them to add them to your service:
    • core_course_get_contents
    • core_course get_courses
    • core_user_get_users
    • mod_assign_get_assignments
    • mod_folder get_folders by_courses
    • mod_forum_get_forums_by_courses
    • mod_glossary_get_glossaries_by_courses
    • mod_lesson_get_lessons_by_courses
    • mod_page_get_pages_by_courses
    • mod_quiz_get_quizzes_by_courses
  7. Click Add functions.
    An image of the Add functions page highlighting the Search Function field and Add functions button.

Obtaining Your API Access Token in Moodle

After creating an external service that contains the necessary API functions, you can now create an API access token with the created service.

  1. In Moodle, go to Site administration > Server.
  2. Select Manage tokens from Web services.
    An image of the Side administration page highlighting the Server and Manage tokens option.
  3. Click Create token on the Manage tokens page.
    An image of the Manage tokens page highlighting the Create token button.
  4. In the User field, select your desired administrator account(s) from the drop-down menu.
  5. In the Service field, select the name of the service that you created in the previous section of this guide from the drop-down menu.
  6. Click Save changes.
    An image of the Create token page highlighting the User field, Service field, and Save changes button.
  7. Copy the token of the new service that you have created from the Manage tokens page.
    An image of the Manage tokens page highlighting the created token.

Adding the Token to Verity

After getting the API access token from Moodle, you can add the access token into Verity.

  1. Navigate to Moodle and click My courses in the navigation menu.
  2. Select any course in which Verity is enabled.
    An image of the My courses page highlighting the My courses button and a selected course.
  3. On the course page, select Verity from the side menu.
    An image of the Verity page highlighting the Verity option from the side menu.
  4. Inside Verity, hover over to the side menu and click Settings > Integration Settings.
    An image highlighting the Settings and Integration Settings button in Verity.
  5. Select LMS API from the Select Integration drop-down menu. 
  6. Click Add Access Key in the LMS API Access window.
    An image highlighting the API selection and Add Access Key button.
  7. Paste the access token that you copied from Moodle, then click Add.
    An image of the Add Access Key window highlighting the Access Token field and the Add button.
  8. Click Save Changes to save your integration.
    An image of Verity highlighting the Save changes button.

Related articles