For Schools

Connecting ManageBac

You must have access to the ManageBac API Manager setting to complete the integration process.

The API Manager will be an option underneath "Develop" in the left-hand bar on the settings page. You must also have the ability to create API Tokens.

Edlink only supports tokens generated through API Manager (Legacy).

ManageBac has begun rolling out a new API Manager (OAuth2) option in their Develop sidebar. Tokens generated through the OAuth2 path are not compatible with Edlink — make sure you select API Manager (Legacy) when following the steps below.

ManageBac offers an API that allows Edlink to securely sync and manage data from ManageBac. For more information on ManageBac's API, see the Reference Documentation or their public help page on ManageBac's website.

If you are connecting Flow ManageBac provides their own documentation here.

Before you begin

Before you can connect Edlink to ManageBac, you need to enable the ManageBac API. To do this, follow the steps outlined in the ManageBac API help page. Edlink will try to sync as much data as it is given permission to access. If there is data missing, please check the permissions granted to Edlink via the API Key settings in ManageBac.

Required API permissions

Validation and sync need more than Students → index and Students → show. Enabling only those will fail later validation steps.

When a resource offers both index and show, enable both.

ManageBac resourcePermissions to enableUsed for
Studentsindex, showStudents validation / people sync
Teachersindex, showTeachers validation / people sync
Classesindex, show, and students when listedClasses validation, student enrollments
Schoolshow, academic-years, subjects, gradesDistrict, sessions, subjects / subject groups, schools

Edlink's Validate Your Configuration step checks access that maps to these resources:

  • Schools → School grades
  • District → School show
  • Teachers → Teachers index / show
  • Students → Students index / show
  • Sessions → School academic-years
  • Classes → Classes index / show
  • Student Enrollment → Classes students

Also enable School subjects so subjects and subject groups sync after validation.

Fastest correct setup: after naming the token, click Read-only at the bottom of the permissions page. That selects the read permissions above (and other read scopes) without granting create/update/delete. You can also click All if your school prefers a broader token.

Parents, Year Groups, Memberships, Tasks, and similar scopes are optional for a passing validation, but enable their index / show (or equivalent read) options if you want Edlink to sync that data.

Setup

To start, click on the administrator integration link provided to you by the learning app.

  1. Click "Get Started"

ManageBac API token permissions covering Students, Teachers, Classes, and School

If validation fails (one or more red X marks), reopen the token in ManageBac API Manager (Legacy) and confirm the required API permissions are enabled. Missing permissions are the most common cause of a failed source validation. See also Troubleshooting Issues.

Well Done!

You're now finished. Your organization's data will appear in the dashboard within 24 hours.

Any Questions?

If you still have questions, please contact our support team and we'll get back to you within 24 business hours.