How to use openSIS API
openSIS is built with APIs. The system allows Superadministrators to access this feature to retrieve data from the system via JSON payload.
To access the API, navigate to Main Menu >> Tools >> API
To start using the API, you have to generate an API key. Before you do that, click on the API Docs link to download and read how to use the API.
Click on the Generate New API Key and give it a title and click Generate.
Once generated, this Key value will be needed to access the APIs. You can generate multiple tokens and they will all be valid for accessing APIs.
Check access of APIs by clicking the gear button and if access is turned off then turn-on access and update it.
You can test the APIs via PostMan.
For School Details, do this:
Your_opensis_URL/api/getSchoolDetails/academicYear/{ academicYear }
Example:
If API Key = TwP3Falr28vDS6cX8R8wCqCheopNzW4psUO9ibQaR/nsxCWlgpMvoQTfQmoTh78UfD
academicYear =2021
Then
URL will be
Go to header section
and write X-API-KEY and paste the value of API Key
Screen Shots of JSON data returned to the browser:
Related Articles
How to Perform Rollover to a New Academic Year in openSIS
Rollover is the process of moving your school data from the current academic year to the next in openSIS. Once a rollover is complete, students can be promoted to the next grade, retained if necessary, and all essential school information—like users, ...How to Bulk Import Staff into openSIS
Managing staff data for an educational institution can be a time-consuming task, especially when dealing with large numbers of personnel. Fortunately, openSIS offers a "Staff Bulk Data Import" feature that simplifies this process, allowing ...How to Bulk Import Students into openSIS
Bulk importing student data into openSIS is a straightforward process that allows school administrators to efficiently manage large numbers of students. This guide walks you through the steps to add or update student records in the openSIS system ...How to Export Data from openSIS
openSIS allows a Superadministrator to download data in Excel format for portability. In the event you want to keep a backup of the data for yourself, or you have decided to move to a different platform, you can download the following data categories ...End of School Year Processing - Rollover
Rollover is the functionality to move the school data from current school year to the next school year. Once a school year is rolled over, students can be promoted to the next grade and failed students can be retained to the same grade level. Also ...