Integration Guide: OneRoster 1.1 API

Summary

OneRoster 1.1 API provides a streamlined and secure method for integrating basic Student Information System (SIS) data into Abre.

What this Integration Does

OneRoster 1.1 API will sync your basic Student Information System data into Abre via API.

Limitations

• OneRoster 1.1 API only shares basic data: students, staff, schools, and classes. 
• Additional data (e.g., demographics, attendance, behavior, grades) must be exported from your SIS and uploaded to Abre separately.

Prerequisites

Before proceeding, ensure you have the following:

• Abre Permissions: Data Monitoring Center Administrator or System Administrator access in Abre.
• SIS Permissions: Administrator-level permissions in your Student Information System.
• Supported SIS: A Student Information System that supports native OneRoster 1.1 integration with OAuth 2.0 authentication.
• Abre SFTP Credentials: Please reach out to your Client Success Manager or support@abre.com to get credentials

Step-by-Step Integration

Step 1: Confirm OneRoster 1.1 API Compatibility

• Verify Compatibility:
  • Contact your SIS account representative or support team to confirm that your SIS supports native OneRoster 1.1 API integration.
• Refer to Common SIS Instructions below:
  For detailed setup guidance, refer to the following resources:
  • Aeries OneRoster API Setup
  • PowerSchool: Contact PowerSchool support to generate API credentials.
  • Infinite Campus Setup (Ensure OneRoster 1.1 with OAuth 2.0 is selected)
  • Skyward API Quick Start Guide
  • If you have a SIS not listed, please reach out to your SIS account representative or support team to confirm OneRoster 1.1 API compatibility

Step 2: Provide Credentials to Abre

Upload the following credentials to your Secure File Transfer Protocol (SFTP) location and notify support@abre.com once uploaded:

• BaseURL
• AuthURL (or TokenURL required for OAuth 2.0 authentication)
• ClientID
• ClientSecret

Note: If your SIS does not provide a TokenURL or AuthURL, confirm that it supports OneRoster 1.1 and OAuth 2.0.

Step 3: Abre synced your data

Once Abre receives your credentials:

• Abre will review and integrate your SIS data.
• You will receive an email notification once the data import is complete.

Step 4: Share Additional Data with Abre

Since OneRoster 1.1 API does not share demographic or other supplemental data, you will need to manually provide these files from your SIS.

Example: Exporting Demographic Data

• Match the Abre Demographic template here.
• Export the file nightly via SFTP to Abre.

Frequently Asked Questions (FAQs)

1. Will demographic data from OneRoster sync with Abre?
No, demographic data is not included in the OneRoster API-Abre integration. You must send a separate demographic file from your SIS.

2. My SIS uses OAuth 1.0. Will that work with Abre?
No, Abre requires OAuth 2.0. If your SIS only supports OAuth 1.0, consider using SchoolDay as an alternative integration solution.

3. What should I do if I haven’t generated OneRoster API credentials before?
Contact your SIS support team for assistance in generating the required API credentials. 

4. How should I share additional data?

Please refer to our Automated SIS Integration.

For further assistance, contact Abre Support at support@abre.com.