How do I set up data integration, or REST API, with a third party?

REST API

An API is a method third-parties use to integrate with ScholarPack and access information. 
There are lots of different API’s available to your school including Wonde, Groupcall, Parentpay, CPOMS, LGFL.

Connectivity with ScholarPack is currently managed in two ways: our older integration which uses our SOAP (Simple Object Access Protocol) API, and the newer REST (Representational State Transfer) API.

You will need to speak to your data or app integrator to ascertain which mechanism they use for transfer, as many are in the process of moving from the older integration to the newer one.

From 17th February 2022, ScholarPack will only support new connections through the REST API. 

REST API is a quick and easy setup. Your integrator will have laid out their software in such a way that you are presented with a link or an option to integrate with ScholarPack. You'll need to check with your integrator as to where this is as we integrate with many partners who often update where these links are.

Once you've found the option to integrate with ScholarPack and selected it, you should be presented with a pop-up that looks like this:

mceclip0.png

Here you simply enter your ScholarPack details - the username and password you'd normally enter when logging into ScholarPack, along with the URL which can be found at the API dashboard page (Admin > Config > API Configuration - just copy the URL displayed top right of your page and paste into the webform School URL section).

mceclip1.png

The user will need to have both Admin and Sysadmin roles on ScholarPack. It's our experience that most schools have set themselves up with the Head, Business Manager and/or main Administrator with both roles.  If you lack the correct rights, an error message will be displayed indicating such:

mceclip1.png

You will need to click the box that you are not a robot.

mceclip0.png

 

Screenshot_2022-01-20_at_08.43.02.png

Once you've logged in successfully, your integrator is free to work with ScholarPack as normal.

 

 

 

 

 

 

 

     

 

 

Was this article helpful?
1 out of 2 found this helpful