API keys

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 and is managed via the API keys page. Several API keys can be configured, each of which can be used to extract a certain aspect of data from Insight.

Creating API keys

New API keys are created using the Add button at the top of the page. An API key has the following options:

Field	Purpose
Key	This is a randomly generated string that cannot be changed
Description	The title given to the key
Role	The API key will use the chosen roles when extracting data. This may affect the data that is extracted, for example by limited the date range over which behaviour information is extracted.
IP address range	A start and end address can be set to create an IP address range. The API key will only function in this range. This is used to add security to the API	Permissions	The information that the key is allowed to extract

Using API keys

A URL is needed to extract data from Insight using the API module. The URL is constructed as follows:

https://insight.school.org/insightapi/ashx?apikey=b25a5fd2-965c-4bc8-b425-dbdc5234e6aa&op=Assignments&adno=002467

	The school's Insight URL
	The API key
	The information required from the API. The list of available information is shown in the Permission field when creating the API key
	The identifying number for the pupil