Vendor RESTful API integrations

Modified on Tue, 21 Apr at 2:14 PM


TABLE OF CONTENTS


Supported vendor integrations are listed below. 

Vendors will advise on the APIs they require, and these APIs can be made available to them as per the directions at https://developer.synergetic.net.au/ - please follow the instructions here!

Synergetic customers will need to be on a version that support the use of the respective APIs, which is articulated on a per-vendor basis as:

Minimum Synergetic version required 71.xx+

Integrations should not require the support of the Synergetic Professional Services team, as all set up and configuration can be done by the client.

Vendors

Campion

image-20250428-000805.png 

image-20250428-000805.png

Minimum Synergetic version required 71.44+

Campion is a dedicated and trusted partner to schools who are seeking to simplify the process of equipping their students with the right learning resources.

Campion Education is an Australian family-owned business and the largest supplier of education resources including print, digital and stationery resources to schools in Australia. We are leaders in digital delivery, and partner with schools to ensure smooth service and unparalleled support - making sure schools can create bright futures for their students.

Campion Education have successfully launched a new API-based data integration. This enhancement offers a more efficient, reliable, and automated way to manage your school’s data.

Requirements:

  • GET apiportal/v1/Student
  • GET apiportal/v1/student/{ID}/class
  • GET apiportal/v1/Staff
  • GET apiportal/v1/Timetable
  • GET apiportal/v1/Community
  • GET apiportal/v1/staff/{ID}/class
  • GET apiportal/v1/LookupTables


Clipboard

image-20250502-050859.png

image-20250502-050859.png

Minimum Synergetic version required tbc

More details TBC


Digistorm

image-20250307-043834.png

image-20250307-043834.png

Minimum Synergetic version required 71.71+

Funnel provides schools with a couple of different integration options with Synergetic. Either through the Synergetic Online Application via XML Import or the Synergetic API Community and Future student endpoints.

Further detail can be found at Digistorm Community 

Guardian Details, and Additional Student Details are now available and expect to be included in a future update.

Requirements:

  • GET /apiportal/v1/community/{studentId}/address
  • GET /apiportal/v1/community/{studentId}/relationship
  • GET apiportal/v1/lookuptables/futurestudent
  • GET /apiportal/v1/lookuptables/document
  • GET /apiportal/v1/lookuptables/medicalcondition
  • GET /apiportal/v1/lookuptables/medicaldetails
  • GET /apiportal/v1/futurestudent/{studentId}
  • GET /apiportal/v1/Community
  • POST /apiportal/v1/FutureStudent
  • PUT /apiportal/v1/FutureStudent
  • POST /apiportal/v1/FutureStudent/Document
  • POST /apiportal/v1/medicaldetail
  • PUT /apiportal/v1/medicaldetail
  • POST /apiportal/v1/medicalcondition
  • PUT /apiportal/v1/medicalcondition


Enquiry Tracker

image-20250721-101140.png

image-20250721-101140.png

Minimum Synergetic version required 71.58+

Enquiry Tracker is a fully integrated CRM, event management, online admissions, reporting & analytics solution all packaged into one seamless and easy-to-use system.

Typical users are the staff working in admissions, marketing and reception who are dealing with families (either current, past or future) navigating the enquiry to enrolment journey. Principals and Business Managers gain instant access to over 35 charts and analytics to assist in strategic decision making.

Enquiry Tracker provides two options for schools to transfer data from Enquiry Tracker to Synergetic. One is via the Synergetic Online Application via XML Import and the other via Synergetic API Community and Future student endpoints.

More information regarding field mapping can be found in the Enquiry Tracker knowledge base

Requirements:

  • GET/PUT/POST/PATCH /apiportal/v1/Community
  • GET/PUT/POST/PATCH /apiportal/v1/FutureStudent
  • GET /apiportal/v1/lookuptables
  • GET/POST /apiportal/v1/medicalcondition
  • GET/POST /apiportal/v1/medicaldetail
  • GET/POST /apiportal/v1/medicalimmunisation
  • GET/POST /apiportal/v1/student
  • GET/POST /apiportal/v1/studentcontact
  • GET/POST /apiportal/v1/studentallergy
  • GET /apiportal/v1/timetable


EnrolHQ

Minimum Synergetic version required tbc

EnrolHQ offers a secure and user-friendly online enrolment system, simplifying the process for parents and school staff. 

EnrolHQ to Synergetic Integration - EnrolHQ

Requirements:

  • GET Lookup Tables

  • GET/POST/PUT Community 

  • GET/POST/PUT Future Student 

  • GET Student Contacts

  • GET Student

  • GET Student Record

  • GET Attendance

  • GET Timetable


Martian Logic

image-20250811-093248.png

image-20250811-093248.png

Minimum Synergetic version required 71.64+

Martian Logic revolutionises HR with cutting-edge software. Automate recruitment, onboarding, and workforce management effortlessly.

Requirements:

  • GET Community 
  • POST Community/Document 
  • POST Community Member
  • PATCH Community Member
  • POST Staff
  • PATCH Staff
  • PATCH Community Address

Find their help material at How to Setup the Martian Logic/ Synergetic Integration 


My School Connect

image-20240723-015551.png

image-20240723-015551.png

Minimum Synergetic version required 71.44+

Synergetic | School management system (SMS) | Tes 

My School Connect is an online solution provider of cashless payment systems and POS integration across schools in Australia. This includes but is not limited to payment solutions for canteen, uniform stores, school events and fundraising. Rich in features with an easy-to-use interface, they offer a smart, simple, and reliable solution that integrates directly with Synergetic’s API which enables seamlessly merging cashless payments, online ordering and data synchronisation that benefits administrators, parents and students.

Requirements (70.18+)

  • GET Student
  • GET Student Contact


Orah

image-20251009-005624.png

image-20251009-005624.png

Minimum Synergetic version required 70.18+

Know where your students are.

Requirements:

  • POST Student Attendances
  • Others TBC


StudentNet

image-20251210-030624.png

image-20251210-030624.png

Minimum Synergetic version required TBC

Requirements TBC


Toddle

 

Minimum Synergetic version required TBC

LMS (Learning Management System) for K12 Schools | Toddle 

Going beyond a typical LMS, Toddle streamlines all aspects of teaching & learning – from curriculum planning and assessments to progress reports and communication.

Requirements (TBC)


FAQ

Your ‘Base URL’

Your Base URL will be something like https://core.schoolname.edu.au/CoreAPI
You can test this by going to the address which should look like below.

image-20250910-055702.png

Available APIs (methods and end points)

Required APIs may include any of these:

File size limitations

Please note that maxRequestLength="10000" (10Mb) is specified in the web.config.

This is usually found on the web server at C:\inetpub\wwwroot\SynergeticCore\CoreAPI\web.config

To increase the maximum size of documents, you will need to update this to maxRequestLength="30000" (or as required) as the value here, and the one in luDocumentType are enforced independently.

 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article