How To Use Opensis Api

title: "How to use openSIS API" url: https://help.opensis.com/portal/en/kb/articles/how-to-use-opensis-api path: Tools

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 toMain 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

Your_opensis_URL/api/getSchoolDetails/academicYear/2021

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: