How to set up your OneRoster integration Follow
What is OneRoster integration?
OneRoster is a standard way for schools to share class and student information between their student information system (SIS) and learning tools like Hāpara. It helps automate the setup and ongoing syncing of classes, teachers and students. This saves time and ensures accurate, up-to-date information.
How to set up your OneRoster integration in Hāpara
Hāpara can sync classes, teachers and students from OneRoster daily or on demand.
To configure OneRoster to Hāpara sync:
- Log in to your Hāpara Admin Console
- Click Class rostering > Admin managed roster
-
Scroll down to Rostering methods to find the OneRoster option. > Click Configure OneRoster to run through the configuration wizard.
Connect SIS
To connect your Student Information System (SIS) to Hāpara using OneRoster, you’ll need the following four pieces of information:
| Token URL | This is the authentication endpoint your SIS uses for OneRoster API access. In most systems (like PowerSchool, Aeries, Synergy, etc.), this is found in the API or third-party integration section of the admin portal. Ask your SIS admin or vendor support if you're unsure. |
|---|---|
| URL Prefix | This is the base URL for your OneRoster API. It often looks like: https://[district].yourSISprovider.net/onero/api/ or similar. It’s usually listed with the Token URL in your SIS API settings. |
| Secret Key (Client Secret) | This is a password-like value generated when setting up the API access. You can find it in the SIS admin console under third-party integrations or API clients. Note: this is often only visible when first created — store it securely. |
| SIS ID (or Org ID) | This is the unique ID that identifies your school or district in the SIS. It's typically found in the orgs.csv file (if using CSV method) or available via the API. Ask your SIS admin or vendor support if you’re unsure which ID to use. |
If you are unsure on where to find your credentials in your SIS, please see our article here which may help.
Tips for common SIS platforms
-
Aeries:
Admin Portal → Security → API Security / Third-Party Integrations → Add API client to get Client ID, Secret, and Token URL. -
PowerSchool:
Admin Portal → System Settings → OneRoster Settings or API Integrations. PowerSchool Support can assist with enabling OneRoster. -
Infinite Campus / Synergy / Skyward:
Check the OneRoster API or SFTP configuration sections under system settings. These often provide Token URLs and credential generation tools.
Still not sure where to look?
If you're not sure where to find one of the required details:
- Contact your SIS administrator or IT department
- Reach out to your SIS support team or vendor
- Or contact Hāpara Support, and we can help guide you through the process
If you encounter errors when adding SIS information, please review our error messages article to understand how to resolve these HERE.
Preview sync data
When you connect your SIS using OneRoster, Hāpara will automatically pull in important student and school information such as:
- Names
- Email addresses
- School codes
- School names
This information appears in the Preview Sync data section, allowing you to review the data as it’s being imported.
Click the Connect button after reviewing data.
Hāpara Configuration
Click Edit configuration to configure Hāpara preferences such as student folders, class name, folder name suffix and sync notifications.
Roster data
View class data
Click the Preview data button to generate a spreadsheet download of the class data our system is pulling from OneRoster.
The Preview data option allows administrators to download a spreadsheet containing the OneRoster class data that will be imported during the sync.
Using this feature helps ensure that all data is accurate and correctly formatted, preventing potential issues during the roster sync process.
Manual sync
For the initial sync, we recommend running a manual sync of the classes and then the students. This allows you to monitor the progress, ensuring there are no errors that need attention before enabling the sync automation.
A manual sync can be kicked off at any time.
You can monitor the sync status from the Data logs page.
Sync automation
Once you are happy with the way your data is looking, it is time to go ahead and enable the daily sync automation. Toggle Sync roster data daily to Yes.
Your first class sync will run around 10 p.m., followed by the student sync around 12 a.m.