API - Revision history

Admin: Redirected page to API keys

2016-04-06T14:57:56Z

Redirected page to API keys

Admin at 16:24, 6 August 2015

2015-08-06T16:24:39Z

Admin: Created page with "{{Additional module}} The Insight API is a tool used to extract data from Insight for use in other applications. The API is an additional module in Insight.

After t..."

2015-08-06T16:21:09Z

Created page with "{{Additional module}} The Insight API is a tool used to extract data from Insight for use in other applications. The API is an additional module in Insight. After t..."

New page

{{Additional module}}
The Insight API is a tool used to extract data from Insight for use in other applications. The API is an additional module in Insight. 

After the Insight API has been purchased, you will need to enable it via the [[service controller]]. Run the service controller on the IIs server that hosts Insight. In the window you will see a checkbox for "enable unsecured API". This needs to be ticked before the API will work. 

Once the API is enabled, you can view a list of the operations it is able to perform by appending "/insightapi.aspx?op=list" to your Insight URL. For example, if the URL to access Insight was https://schoolwebsite/INSIGHT the URL to view the API operations would be https://schoolwebsite/INSIGHT/insightapi?op=list 

This will show you a list of the valid operations. You can click on each of the operations and the browser's address bar will show you the URL that you need to use to extract the relevant data. The URL would be something like: https://schoolwebsite/INSIGHT/insightapi.aspx?op=behaviourpoints 

However this is not complete, you also need to append a string of text that tells Insight which pupil's data you wish to retrieve. You can use one of the following below: 

&unsecuredpupilid=XXXX where you replace XXXX with the pupil's ID number from SIMS 
&unsecuredpupilupn=YYYYYY where you replace YYYYYY with the pupil's UPN number 
&unsecuredpupiladno=ZZZZZZ where you replace ZZZZZZ with the pupil's admission number 

For example, a complete URL could be: https://schoolwebsite/INSIGHT/insightapi.aspx?op=behaviourpoints&unsecuredpupilid=1234 

You must use IPsec in conjunction with the Insight API. The URL links are not password protected and if you do not use IPsec, anybody could access sensitive information about pupils at school if they guess the correct fields. 

[[Category:Configuration]]
[[Category:Additional modules]]
[[Category:Technical]]

← Older revision		Revision as of 14:57, 6 April 2016
Line 1:		Line 1:
−	~~{{Additional module}}~~	+	#REDIRECT[[API keys]]
−	~~The Insight API is a tool used to extract data from Insight for use in other applications. The API is an additional module in Insight. <br> <br>~~
−
−	~~After the Insight API has been purchased, you will need to enable it via the~~ [[~~service controller]]. Run the service controller on the IIs server that hosts Insight. In the window you will see a checkbox for "enable unsecured~~ API~~". This needs to be ticked before the API will work. <br> <br>~~
−
−	Once the API is enabled, you can view a list of the operations it is able to perform by appending '''/insightapi.aspx?op=list''' to your Insight URL. For example, if the URL to access Insight was <nowiki>https://schoolwebsite/INSIGHT</nowiki> the URL to view the API operations would be <nowiki>https://schoolwebsite/INSIGHT/insightapi?op=list</nowiki> <br> <br>
−
−	This will show you a list of the valid operations. You can click on each of the operations and the browser's address bar will show you the URL that you need to use to extract the relevant data. The URL would be something like: <nowiki>https://schoolwebsite/INSIGHT/insightapi.aspx?op=behaviourpoints</nowiki> <br> <br>
−
−	~~However this is not complete, you also need to append a string of text that tells Insight which pupil's data you wish to retrieve. You can use one of the following below: <br> <br>~~
−
−	~~'''&unsecuredpupilid=XXXX''' ''where you replace XXXX with the pupil's ID number from SIMS'' <br>~~
−	~~'''&unsecuredpupilupn=YYYYYY''' ''where you replace YYYYYY with the pupil's UPN number'' <br>~~
−	~~'''&unsecuredpupiladno=ZZZZZZ''' ''where you replace ZZZZZZ with the pupil's admission number'' <br> <br>~~
−
−	~~For example, a complete URL could be: <nowiki>https://schoolwebsite/INSIGHT/insightapi.aspx?op=behaviourpoints&unsecuredpupilid=1234</nowiki> <br> <br>~~
−
−	You must use IPsec in conjunction with the Insight API. The URL links are not password protected and if you do not use IPsec, anybody could access sensitive information about pupils at school if they guess the correct fields. <br> <br>
−
−	~~[[Category:Configuration]]~~
−	~~[[Category:Additional modules]]~~
−	~~[[Category:Technical~~]]

@@ Line 4: / Line 4: @@
 After the Insight API has been purchased, you will need to enable it via the [[service controller]]. Run the service controller on the IIs server that hosts Insight. In the window you will see a checkbox for "enable unsecured API". This needs to be ticked before the API will work. <br> <br>
-Once the API is enabled, you can view a list of the operations it is able to perform by appending "/insightapi.aspx?op=list" to your Insight URL. For example, if the URL to access Insight was https://schoolwebsite/INSIGHT the URL to view the API operations would be https://schoolwebsite/INSIGHT/insightapi?op=list <br> <br>
+Once the API is enabled, you can view a list of the operations it is able to perform by appending '''/insightapi.aspx?op=list''' to your Insight URL. For example, if the URL to access Insight was <nowiki>https://schoolwebsite/INSIGHT</nowiki> the URL to view the API operations would be <nowiki>https://schoolwebsite/INSIGHT/insightapi?op=list</nowiki> <br> <br>
-This will show you a list of the valid operations. You can click on each of the operations and the browser's address bar will show you the URL that you need to use to extract the relevant data. The URL would be something like: https://schoolwebsite/INSIGHT/insightapi.aspx?op=behaviourpoints <br> <br>
+This will show you a list of the valid operations. You can click on each of the operations and the browser's address bar will show you the URL that you need to use to extract the relevant data. The URL would be something like: <nowiki>https://schoolwebsite/INSIGHT/insightapi.aspx?op=behaviourpoints</nowiki> <br> <br>
 However this is not complete, you also need to append a string of text that tells Insight which pupil's data you wish to retrieve. You can use one of the following below: <br> <br>
-&unsecuredpupilid=XXXX where you replace XXXX with the pupil's ID number from SIMS <br>
+'''&unsecuredpupilid=XXXX''' ''where you replace XXXX with the pupil's ID number from SIMS'' <br>
-&unsecuredpupilupn=YYYYYY where you replace YYYYYY with the pupil's UPN number <br>
+'''&unsecuredpupilupn=YYYYYY''' ''where you replace YYYYYY with the pupil's UPN number'' <br>
-&unsecuredpupiladno=ZZZZZZ where you replace ZZZZZZ with the pupil's admission number <br> <br>
+'''&unsecuredpupiladno=ZZZZZZ''' ''where you replace ZZZZZZ with the pupil's admission number'' <br> <br>
-For example, a complete URL could be: https://schoolwebsite/INSIGHT/insightapi.aspx?op=behaviourpoints&unsecuredpupilid=1234 <br> <br>
+For example, a complete URL could be: <nowiki>https://schoolwebsite/INSIGHT/insightapi.aspx?op=behaviourpoints&unsecuredpupilid=1234</nowiki> <br> <br>
 You must use IPsec in conjunction with the Insight API. The URL links are not password protected and if you do not use IPsec, anybody could access sensitive information about pupils at school if they guess the correct fields. <br> <br>

API - Revision history

Admin: Redirected page to API keys

Admin at 16:24, 6 August 2015

Admin: Created page with "{{Additional module}} The Insight API is a tool used to extract data from Insight for use in other applications. The API is an additional module in Insight. After t..."

Admin: Created page with "{{Additional module}} The Insight API is a tool used to extract data from Insight for use in other applications. The API is an additional module in Insight.

After t..."