For Developers
SDK Overview
The Edlink SDK is a TypeScript library designed to simplify interaction with the Edlink API for both TypeScript and JavaScript projects. While direct HTTP requests to the API are always an option, the SDK offers many conveniences that can reduce boilerplate code and speed up development for you. It also provides types for Edlink entities so you don't have to write your own.
Looking for a different SDK? Let us know.
Use Cases
The SDK covers the major use cases of the API including:
- Rostering: syncing schools, classes, people, enrollments, etc.
- Coursework: creating assignments, submitting work, syncing grades, etc.
- Extended Data: accessing additional data like calendars, fees, assets, rooms, facilities, and incidents, and more.
Features
- TypeScript Types: The SDK provides types for all Edlink entities that it returns, making it easy to work with Edlink data in a type-safe manner.
- Filtering and Pagination: The SDK includes built-in support for filtering and paginating results, making it easy to retrieve only the data you need and to process large datasets efficiently.
Check out the TypeScript SDK
Developer Guide
Click to Read