iSAMS - About the REST API

Suggest Edits

About the REST API

The REST API is designed so that 3rd party software developers and internal school developers can access data in real-time and perform data reads and writes. It can be used to extend iSAMS functionality or integrate another solution into the iSAMS data access.

A school must first request access to the REST API for a Partner from iSAMS support and in return will be provided with a Client ID and Client Secret which can be used to obtain a token providing access to the REST API endpoints using Bearer Authentication.

Data can be requested in either JSON or XML for all REST API endpoints using content headers.

REST API Costs & Pricing

The REST API is only available to iSAMS Partners on the Developer Standard and Enterprise plans and requires the iSAMS client school to have an active subscription to the API Services Manager.

3rd party software suppliers must make it clear to schools that do not currently subscribe to the API Services Manager that this is a chargeable extra that must be budgeted for each year. Once a school has paid its annual subscription they can request REST API credentials to be generated for 3rd party software suppliers on the Developer Standard and Enterprise plans.

Schools and School Groups may also join the iSAMS Integration Partner scheme if they wish to undertake internal development projects using the REST API. Please note that this is in addition to the requirement for a subscription to API Services Manager.

For more information on iSAMS Partner plans, visit the iSAMS Marketplace.

REST API Support

The level of support provided by iSAMS for the REST API is dependent upon the type of Partner Plan an iSAMS Partner has. Developers who wish to use the REST API should consult the documentation contained within this portal and the iSAMS Swagger documentation.

It is recommended that 3rd party software suppliers work with an iSAMS school to develop the necessary data requests and data processing routines before making it available to the wider iSAMS client community.

REST API credentials are not visible in the API Services Manager because these are manually managed by iSAMS until the Partner Marketplace website is developed to support the management of these.