To integrate with the ScholarPack MIS you must first authorise the API (Application Programming Interface). This enables the limited sharing of data between the ScholarPack and ParentPay systems in order to upload specific pupil, staff and pre-admission records.
- To begin the process you will need to ensure that your site has been enabled for upload via the V2 API by a member of the ParentPay team.
- You will also need to have your ScholarPack login credentials and application URL in order to authorise the API
- Log in to your ParentPay Manager Application (as an overall manager)
- Navigate to People > Uploads
- Ensure you are on the ScholarPack access permissions tab (below)
- Select Login with ScholarPack
- Enter the required details from your ScholarPack instance. These should be the same credentials you use to log in to ScholarPack
- Select Login
- Select Confirm
- A confirmation message will be provided:
- In most cases, a success banner providing a summary of the data that can be shared through the API is displayed.
- An error may be encountered. This is normally the result of entering the credentials incorrectly.
- In most cases, a success banner providing a summary of the data that can be shared through the API is displayed.
Once configured correctly the API is authorised for an integrated upload to be completed and an option to Go to ScholarPack import or Revoke access is provided.
Please note: Managers maintain the ability to revoke access from this screen at any time.
Once enabled, the Import tab will be visible in Attendance, meals and events within the manager application.
Select Import to open the meal import side menu.
Scholarpack meals import
Normally, this page will be used to import meal attendance data. Immediately after the system has been enabled however, this page will display an error message indicating that the meal integration requires authenticating.
How to configure and manage authenticated access is covered in the next section.
ScholarPack meals access
To link the meal solution to ParentPay, select the Login to Scholarpack button, as below:
This opens the ScholarPack login page allowing you to set up authorised access.
Please note: These credentials are not stored in ParentPay. When completing the log in an authorised token is created and stored. This is used whenever a meal import is attempted. You can remove this token at any time (covered later in this document). If the authentication fails at any time you will need to reauthorise the meal integration.
You will need to enter your Scholarpack login credentials to proceed. As a minimum, the system requires your Username, Password and School URL. This uses the same structure as setting up the pupil upload interface, covered in this article.
Once you have successfully authenticated the integration you will receive a success message in your manager application window:
Please note: You can remove this access at any time by selecting the Revoke meal access button. Once removed you will need to authenticate in order to get the integration to work again
Once this part is complete you can immediately perform ScholarPack Meal Attendance uploads by selecting the Go to ScholarPack upload button. To learn more about managing the system, go to Using ScholarPack Meal Attendance.