We just launched a major update to our API. Now, in addition to creating users, it supports organizations, classes, and rosters. That means your Student Information System (SIS) and other school software can communicate with Haiku LMS, so as you make changes in one place they’re immediately reflected in the other.
This release (version 5.1) also adds the ability for students to move and copy content blocks in WikiProjects, but the big news is the API updates.
What is an API?
API stands for application programming interface. It’s a way for two or more different pieces of software to talk with each other and pass information back and forth. Your IT department or SIS developer can simply write an application based on our API specifications, then whenever your school secretary or SIS administrator enrolls a student or updates a class roster, the changes will be instantly pushed to Haiku. If Haiku encounters any errors, your application will know right away and can respond appropriately. That translates to huge time savings so that information can be managed in one place and automatically reflected in others.
Can’t I already import my data?
Haiku LMS has always offered imports using CSV (comma separated value) files, but while CSV imports are often more simple to set up initially, there are several distinct disadvantages to this type of import. The API is an optional replacement for CSV imports.
Problem: They aren’t instantaneous. Automated CSV imports only run once per day, which means that changes in the district SIS take time to be reflected in Haiku.
Solution: The API offers a way for schools to tightly couple their SIS with Haiku LMS. Once this integration is complete, updates to the SIS are immediately and automatically submitted to and reflected in Haiku LMS.
Problem: The Domain Admin has to manually review Haiku LMS import error logs for bad data in their CSV files.
Solution: When data is updated via the API, Haiku LMS provides instant, computer-understandable feedback if there are any errors. The integrated SIS can display these errors to the SIS administrators so that they can resolve the problem.
Problem: Previously, there wasn’t an efficient way to extract data from Haiku LMS once it was imported. (We do offer CSV exports, but Domain Admins must manually generate and download them.)
Solution: The API can be a way for a school to pull data from Haiku LMS. For example, a school could write an application that checks to see if any users have updated their email address in Haiku LMS and then copies those new email addresses to the SIS. The API even gives read-only access to information about manually-created users and classes. That means that your school could use the API to get up-to-date parent information, even if your SIS doesn’t yet support parent accounts.
The Specific Details
For the specific, technical information check out our API documentation site for developers or the complete release notes.
Not sure whether you want to use the API? There are several options for importing you school’s data into Haiku.
Looking Ahead
Let us know if you have questions or ideas. In the meantime, here’s what else is in the works:
- Versioning System: WikiProjects and Pages will have a log of all changes any user makes and allow rollbacks to revert to previous versions.
- Google Docs: Write blocks collaboratively in Pages and WikiProjects.
- SCORM Player: Run SCORM-compliant content you created in another system in Haiku.
- Dropbox Annotations: Thanks to TutorTrove’s technology, teachers will be able to open files like Word docs that students turn in via the Dropbox and write comments and notes directly in the browser – no need to download the file, mark it up, and upload for the student. (If you were at ISTE 2010 you got a sneak peek!)
- Aggregated Comments: Just for teachers, Haiku will aggregate all the comments made so that comments on WikiProjects and Pages are available in one place. The teacher can also see all comments by one student.
