Prepare for your Hāpara OneRoster setup call Follow
School and district admins: Before your implementation call, confirm OneRoster access with your SIS provider, gather your connection details and school SourcedIDs, and submit them to Hāpara for connection testing.
Summary: Complete this checklist before your call so your implementation team can help connect OneRoster and review your roster data.
1. Confirm OneRoster access with your SIS provider
Ask your student information system (SIS) administrator or provider to confirm:
- Your system supports OneRoster 1.1 and a REST API.
- API access is enabled for the Hāpara integration, with permission to read schools, academic sessions, courses, classes, users and enrollments.
- Any vendor approval or access restrictions have been addressed. If IP allowlisting is required, contact Hāpara Implementation for the details to use.
2. Gather your connection details
Request the following from your SIS administrator or provider. Use the exact values supplied for your integration.
| Detail | What to prepare |
|---|---|
| Student domain | The domain after the @ in student email addresses. |
| Client ID or Key | The identifier for your API integration. |
| Client Secret or Secret Key | The confidential value used to authenticate the connection. Store it securely when generated. |
| Token URL | The authentication endpoint used to request an access token. |
| URL Prefix or Base / Source URL | The OneRoster API base address. This is different from your SIS login page. |
| School SourcedIDs and names | The OneRoster identifier and name of every school you want to sync. |
Tip: Ask your provider to identify the school SourcedID in the OneRoster feed. Avoid assuming that a familiar school number is the correct value.
3. Submit your details before the call
- Complete the Hāpara Secure API Details Submission Form.
- Include each school’s SourcedID and name on a separate line.
- Let your implementation contact know you have submitted the form, and flag any details you are still waiting for.
Submitting these details in advance allows the Hāpara team to test the connection before configuration. Use the linked form to share your API secret.
4. Check your roster data and school details
- Confirm which schools and school year or term should be included.
- Check that the intended classes have teachers and students assigned, with the correct account email addresses.
- If your schools already exist in Hāpara, note their school codes under Hāpara Admin Console > Schools. Flag any differences from the OneRoster school identifiers for review during the call.
Have a sample class ready, including its teacher and expected students, to help check the results together.
5. Arrange access and the right people
- Check that you can sign in to the Hāpara Admin Console.
- Arrange for someone who can manage SIS API settings to attend or be available if changes are needed.
-
Have your SIS provider’s support contact available for questions about credentials or data.
If you are changing rostering methods
Tell your implementation contact which method you currently use and your preferred changeover date. Review the Transition to OneRoster Administrator guide beforehand.
Coordinate archiving, school-code changes and the changeover with Hāpara Implementation. Plan for any effects on teachers’ existing classes, scheduled sessions and linked Workspaces.
Ready for your call
You should have confirmed API access, submitted the connection details, identified the schools to sync and arranged admin access. During the call, your implementation team can help configure the connection, review the available data and agree on the next sync steps.
If anything is missing, contact implementation@hapara.com before your appointment and explain what is outstanding.
For the configuration walkthrough, see How to set up your OneRoster integration.