Search

Schoox Integration

Certiverse Schoox Integration

Overview

Certiverse exams can be configured to verify a candidate’s eligibility in Schoox when the candidate schedules an exam.

Eligibility Verification

Certiverse uses API calls to confirm that:

  • A Schoox student account exists with the same email address as the candidate’s Certiverse account.
  • The student is actively enrolled in the course configured for the exam.

Enrollment Completion

After the candidate completes the exam, Certiverse uses the Schoox Admin API to close the candidate’s enrollment in the configured course.

Schoox Configuration

For instructions on configuring the required course and SCORM learning object, see the Schoox LMS Configuration section below.

Schoox Connector Configuration

Establishing the Schoox Eligibility Connector

  1. Log in to Certiverse
  2. Navigate to the Admin Portal
  3. Select the Connectors tab
  4. In the left menu, choose Eligibility
  5. Click Connect on the Schoox card
  6. Click Add Connector (top-right)

Connector Setup

General Settings

  • Connector Type: Eligibility
  • Connector Name: Provide a display name for the connector

Schoox Eligibility Credential Settings

  1. Provide the following information:
    1. Partner Endpoint
      • Base URL
    2. Academy Credentials
      • Academy ID
      • API Key
      • Note: Credential values are obfuscated once saved.
  2. Click Validate to ensure the connection is valid
  3. Click Create

Store Configuration

  1. Navigate to the Store tab
  2. Click EDIT for the desired exam
  3. Locate the Eligibility Configuration tab within the Exam
  4. Select the configured Organization Connector (Schoox)
  5. Select the Schoox Course that will be used to determine exam eligibility
  6. Click Save

Schoox API Integration Behavior

Candidate Flow and Eligibility Verification

Eligibility verification between Certiverse and Schoox occurs when a candidate selects an exam from either the Organization landing page or a direct exam deep link. If the candidate is not already logged in to Certiverse, they will be prompted to log in or create a new account. The email address associated with the Certiverse account must match the email address on the candidate's Schoox account used for course enrollment.

  • If the candidate is eligible and actively enrolled in the configured Schoox course, they may proceed to book the exam.
  • If the candidate is not eligible or not actively enrolled, they will be denied the option to book the exam.

Candidate Exam Results and Enrollment Closure

After the exam is completed, Certiverse closes the candidate's enrollment in the configured Schoox course using the Schoox Admin API endpoint. Note that, unlike some other LMS integrations, a numeric score is not stored in or sent back to Schoox — enrollment closure marks the course activity as complete without posting the exam score.

Troubleshooting Candidate Eligibility Configuration and Candidate Eligibility

When verifying exam eligibility in Schoox, there are multiple steps involved. If the candidate's eligibility cannot be verified, the system will provide additional feedback. This feedback can help identify and resolve any issues.

The table below lists common system feedback messages that you can use to diagnose and resolve eligibility configuration and candidate eligibility issues.

System Feedback Message Explanation How to Resolve
Schoox authentication is not valid The Schoox credentials (Base URL, Academy ID, or API Key) are not valid Verify that the Schoox credentials configured in the Certiverse connector are still valid
User not found The Schoox user is looked up using the email address from the Certiverse candidate account. No user with this email address exists in the corresponding Schoox academy. Ensure that the candidate is using the same email address in the Certiverse platform and the Schoox platform.
Enrollment not found or not active An active enrollment was not located in Schoox for this user in the course configured in the Certiverse platform. If eligibility is working for other candidates, ensure that the candidate is actively enrolled in the correct Schoox course and that their enrollment has not already been completed or closed. If eligibility is not working for any candidate, verify that the course configured in the Certiverse platform matches the intended Schoox course and that it is configured correctly.

Eligibility Flow with API Calls

Eligibility Verification

  1. User lookup
    • The email address used to create the Certiverse account is passed to the Schoox API and the matching Schoox user is returned.
    • The candidate is not eligible if no user is returned.
  2. Enrollment in the Schoox course verified
    • Certiverse verifies the user's enrollment in the course configured in the Certiverse Eligibility Configuration.
    • The candidate is not eligible if:
      • No enrollment is found for the configured course
      • The enrollment is not active (e.g., already completed or closed)
  3. Exam completion and Schoox enrollment closed
    • Upon exam completion, Certiverse calls the Schoox Admin API endpoint to close the candidate's enrollment in the configured course.
    • No score is posted back to Schoox; the enrollment is simply closed/completed.

Schoox LMS Configuration

Organizations must ensure proper configuration within Schoox. Certiverse needs a course in which the candidate is enrolled, as this active enrollment determines exam eligibility. Certiverse will use API calls to Schoox to confirm that a user with the candidate's email address is actively enrolled in the designated course.

Ensure that the API Key used in the Certiverse connector has Admin API access to the relevant Schoox academy, as this access is required both to verify enrollments and to close them when the exam is complete.

Schoox Course and SCORM Object Configuration

Properly configuring the course in Schoox is essential for a seamless, reliable integration. The following guidance outlines best practices for setting up exam eligibility in Schoox.

Schoox Learning Object

The learning object/module used for this integration is a SCORM object. After you create a course in Schoox, add a SCORM object as the course's learning material. This SCORM object will contain the deep link that directs learners to the exam in the Certiverse Exam Store.

Schoox Learning Object Configuration

Add a hyperlink within the SCORM object that directs learners to the exam in the Certiverse Exam Store to create a seamless experience. Ensure the course remains open (not marked complete) until Certiverse verifies eligibility and closes the enrollment after the exam is completed.

Contact Us

If you have any questions or need additional assistance, please contact us by either emailing support@certiverse.com or by submitting a ticket from this article.

 

Updated

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.