The Edlink API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. The purpose of this API is to enable educational software developers to quickly connect to a variety of school data sources in order to provide a smooth workflow for teachers, students, and administrators.
Edlink data connections create an instant bi-directional data flow between your platform and the school's LMS, SIS, or related system. By drawing information from, and sending information to the LMS, your developers can build rich experiences that fit seamlessly into existing classroom environments, with virtually no setup time on the part of the teacher or administrator.
We strive to support as many different data sources and standards as possible. By doing the heavy-lifting up front, we can provide our partners with integration capabilities that are far beyond what any given standard can currently provide. Currently, we are compatible with various API, LTI, and OneRoster implementations.
Graph API Overview
The Graph API enables you to access LMS information at the school or district level. All requests are made with a district-level access token. For example, when you make a call to retrieve a list of people, the list will contain all people at the district. This differs from the User Data API, which you can read about below.
- The Graph API provides access to bulk school data through a single set of endpoints.
- The Graph API connects to a variety of school data sources, such as the school's LMS, SIS, etc.
- The Graph API is bi-directional and can retrieve data as well as post data to school systems.
- The Graph API can limit your exposure to unnecessary or sensitive student data through Sharing Rules.
User Data API Overview
The User Data API enables you to add single sign on, rostering, content, and gradebook integration with school data sources. All requests documented in this section are scoped to the authenticated user. For example, when you make a call to retrieve a list of courses, you will receive a list of courses in which the requesting user is enrolled. You will not receive a list of all courses within an entire school or district.
- The User Data API provides access to information relating to the user who is currently signed in to your application.
- The API is bi-directional which allows you to perform functions like syncing grades or submitting assignments.
- Edlink Sharing Rules also apply to user data here, so you will not see data that you are not allowed to access.
Metadata API Overview
The Metadata API provides a way of interacting with Edlink as a platform, rather than data for an individual school. This API is still in development, but we are happy to help you get started with it. If you have a use case that requires you to set overrides in bulk, or via some automated process, please contact your Edlink client success manager.
Conclusion
The Edlink API provides a fast and easy way to integrate your platform with school data sources like the LMS or SIS. Instead of receiving raw student and teacher data on a nightly basis, you are able to interact with the LMS on-the-fly and in a bi-directional manner. Whether you want to access data at the district level or school level, Edlink makes it fast, easy, and consistent.
For more help in getting started, check out the Edlink Community section for guides and step-by-step tutorials.