Rostering (OneRoster API) Certification Guide

OneRoster API integrations allow you to pull district data into your integration if the district chooses to share it. OneRoster API Сertification determines that an integration compatible with OneRoster standards. 

Overview

Once you have developed your integration in the School Passport Sandbox, you may request its certification. Your integration will be verified by the GG4L Engineering Team in accordance with Certification requirements. The review process typically takes about 5 business days. Once the review is complete, you will receive an email containing your certification results and recommended next steps. If necessary, we can also schedule a call to discuss the integration in more detail.

Stage 1: Preparation for certification

Before requesting certification, review the technical requirements and eligibility qualifications that your integration must meet.

Readiness checklist

• Create an integration in School Passport Sandbox.
• Ensure that your integration meets the integration requirements and OneRoster API specification.
• If you also have developed an SSO integration, review the SSO Requirements and ensure that your integration meets these requirements. After that, you can skip the SSO Certification Survey.

Requirements

For an integration to qualify for OneRoster API Certification, it must meet the following criteria and all the technical requirements.

• Your integration must use GG4L ID as a key identifier for all data types.
• Your integration must have at least a daily data update
• Your integration must handle missing data fields for non-required attributes according to School Passport's data schema.
• Your integration must archive data when information is no longer shared or has been deleted from School Passport. If the GG4L ID associated with that data reappears, your integration should be able to restore or bring back those archived records. 

Stage 2: Request for certification

When your integration meets all requirements provided earlier, request certification by completing the following survey:

Certification Survey

Stage 3: Certification approval

GG4L Engineering Team will verify your request and provide you with the next steps within 5 business days.

Stage 4: Production and publishing

After your certification is approved, we will duplicate your Sandbox integration to your production environment. You will find your integration in the dropdown menu at the top of your production dashboard.