Set up Data Integration, or REST API, with a Third Party

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. You can see further details here: Frequently used API integrations

Connectivity with ScholarPack is managed via our REST (Representational State Transfer) API. 

You will need to have both Admin and System Admin roles on ScholarPack. If you don’t have this, you’ll need to ask your team to give you access by following these instructions: How do I add a user role to a staff member?

If you lack the correct rights, an error message will be displayed.



You'll need to check with your integrator for the link or an option to integrate with ScholarPack, as we integrate with many partners who often update where these links are. Once they have shown you where to go to set up the integration, you should be presented with a pop-up that looks like this:



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).



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

Top Tip: if it keeps clearing your password, this could be caused by a URL not including a "/" on the end of it. Try submitting it again with a forward slash on the end of the URL.



Once you've logged in successfully, your integrator will work with ScholarPack.



Why can I still not connect?

Please double check you have followed all the steps in this article, the login and URL information you're providing is correct and you have the necessary user roles.

If you've done all this but you're getting an error message, or you're still unable to approve the connection, you will need to contact the API you're trying to set up the connection with.

As the connection is managed solely by the third-party company, they are the only ones with access to the connection setup to troubleshoot and diagnose what may be going wrong.

You can see how to get further support here: Information is not pulling through or is showing incorrectly in my Third-Party APP

Was this article helpful?
0 out of 0 found this helpful