This how-to guide will explain how you can give access to your school data to a third party, securely, using our API.
Third party providers are setup centrally by Horizons. Schools need to authorise access to their data. In most cases full access is not necessary and so the following steps (developed Aug 2019) are in place to control third party access to school data.
- To check that the third party is on the approved list navigate to Admin > Export > External API Integration.
- Approve the third party by clicking on the “Authorise” button. You can revoke their access to your data at any time.
- You can also control what data the third party has access to. If the box is ticked, the third party has access.
Your data has been grouped into the following areas:
School info
Shares basic school information like school name, LEA, establishment number, address.
Students
Shares information relating to pupils/students like name, DOB, UPN, year group, pupil premium, ethnicity.
Behaviour
Shares a list of behaviour incidents and associated categories for students.
Read Attendance
Shares attendance summaries for students.
Write Attendance
This is the only function that allows third parties to write to the Horizons database. Attendance can only be written for the current day.
Contacts
Allows access to the parent records of students. Their name, email address, phone number, any court orders.
Staff
Shares records of school staff like name, DOB, contact details. Please note that contracts and salaries can only be included by request.
Groups
Shares a list of active pupil groups (classes, sets, houses) and their members (staff and students).
Photos
Shares student photos.
Live School
Shares live school elements like rooms, 3D layout, seating plans.