Follow

API Configuration

 

apiicon.PNG

Admin > Config

The API (Application Programming Interface) configuration application will allow schools to set up and control their own 3rd party integrations with other software providers.  Through this application you will be able to activate data exchange with another software provider, terminate the process, see what data has been used by the 3rd party and when the API was terminated and by who.

User roles required to manage the API connections

Not all user roles will allow you to activate the API application, set up individual API access for one of the listed 3rd party providers or terminate the API.

System Admin: With the System Admin role you can activate an individual API with a specific company.  You can also terminate any of the current integrations.

Admin: With the Admin role you are only able to deactivate any of the existing API connections.  

The first part of the management page will give you some background information on the companies we currently have an API with, the data that can be extracted by the 3rd party and how you set up the API with the 3rd party software provider.

apinewv2.PNG

A full list of the data that can be exchanged with 3rd parties can be seen  APIman2.PNG.  This will show you a document that details what each of the data types contains.

Setting up an API with your 3rd Party Software Provider

The first stage is to  APIman8.PNG with the provider you wish to work with and who you are happy to allow access to the schools data. 

apiman20.PNG

 

Once you have selected to enable API access, you will be presented with a window to confirm you wish to complete the task.

apiman.PNG

The access window will show which data will be shared with the software provider selected.  The default selections are highlight and selected for you but you can change the choices made. 

Be aware that changing any of the choices may affect how your third party software works for your school and should only be changed in consultation with your provider. 

Once you have correctly completed the simple maths task, you will be offered the option to

apiman2.PNG

You will be then presented with some information that you will need to forward to your 3rd party software provider.  This information contains the school name, the web address for the school (URL) and an unique security number that will only work with the company selected.  It will also list the data options activated.  Full details of each data field can be found here 

apiman3.PNG

Once access has been enabled, you will see that the management console will show which APIs are active, you will be able to see the access details required by the 3rd party (as above) and a log of any data transactions made with the 3rd party.  You will also be able to deactivate the API when required. 

apiman4.PNG

Access Logs    

The access logs will give a summary of which ScholarPack user has activated/deactivated a particular API together with a history of the type of data extracted by the 3rd party and when.

APIman10.PNG

APIman11.PNG

The type of data extracted is listed and you are able to see full details on what it containes by selecting APIman12.PNG.  This will show you the full extent of the data being extracted and used by the 3rd party provider.

For a more detailed report on data extractions and API interaction, at the bottom of the summary reports you can select APIman2.PNG.  This will show each instance of the API being activated/deactivated and by who and each data extraction including whether it was successful.  It will also allow you to see which data set (endpoint) the 3rd party has been using.  The endpoints are labelled by a letter of the alphabet and more details can be seen on what each endpoint contains in the "What Data is available through the API" panel at the top of the management console.

Removing API to a Company

To deactivate an API select the APIman13.PNG.    This will prevent your 3rd party supplier from accessing you school database and it may affect how their software application works with your school.  This step can be completed by users with either the admin or system admin role.  As part of completing the process you will again be asked a simple maths question.

apiman5.PNG

You can reactivate the API by following the steps as above.  

 

 

 

     

 

 

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request
Powered by Zendesk