Wonde API

Overview - Wonde API

Are you sure you want to remove this component?

The Wonde API populates the School User Data Store (SUDS) with user profile and timetable information, and also imports tutors into student profiles. 

Wonde, as a product, integrates with a range of Student Information Systems (SIS). It works as a conduit to then supply information to SUDS in a consistent method.

Once SUDS has been populated, the User Provisioning System (UPS) is able to run as a scheduled process for the creation of and ongoing updates to a user’s Schoolbox Profile. A user's timetable and profile page (that directly rely on the Wonde API data in SUDS) will surface the most recently uploaded information as per the schema and do not require the UPS to have completed its scheduled run (though caching of data may delay this). 

NOTE: Due to the duration that the import of data can take, it is recommended that an hourly sync is NOT used.

To understand how a SIS integrates with Wonde, please see the Wonde Integration Guides and Wonde Integration Guides AU.

On this page, you will find the following information:

Generating your Wonde API Key

Managing the Wonde API Connector

Managing the Wonde API Imports

Mapping of Staff - Wonde API to SUDS

Mapping of Students - Wonde API to SUDS

Mapping of Parents & Relationships - Wonde API to SUDS

Generating your Wonde API Key

Are you sure you want to remove this component?

Managing the Wonde API Connector

Are you sure you want to remove this component?

  1. Log in to Schoolbox.
     
  2. Go to Administration > School Data Import > Home.
     
  3. In Data Source, select the data source as 'Wonde'.
     
  4. Enter your School Data Endpoint Host.
     
  5. Choose your Import Frequency.
    Note: It is recommended that an import is conducted after midnight to ensure that SUDS is populated with the correct timetable day, school staff, and to gather current profile data (including new starters). The completion of this import should precede the User Provisioning System’s scheduled run. An additional import before the start of the school day may be utilised to present changes made to the timetable for cover lessons and room changes that may have been made in the SIS that day. A final import after working hours can also be utilised to update any changes made by the SIS administrators that day.
     
  6. Enter your Import Timeout.
     
  7. Enter your Wonde Configuration School Identifier and Token.
     
  8. Select Save.
    image.php?hash=206469009c45fb19cdae4787879455e2886f67e3
Back To Top

Managing the Wonde API Imports

Are you sure you want to remove this component?

Schoolbox gives you more control over how you import data using School User Data Store (SUDS) from an API connector into Schoolbox. You can now import specific groups of data - like user profile data, timetable data - separately, instead of all at once.

This will help you when you want to make small updates or test new data without affecting everything in your system.

To perform an update of your SUDS data from an API connector:

  1. First, ensure you have enabled school data import for your school. See Managing the School User Data Store (SUDS). 
     
  2. Next, go to Administration > School Data Import > Home.
    This opens the school data import home page for you. 
     
  3. Then, select the 3-dot menu icon3-dot Menu Iconand select one of the following:
    • Update user data and timetables
    • Update user data only
    • Update timetable only
  4. For each, select Save to proceed with the import.
     
  5. Next, in Daily Org Import Time, enter the specific time of day when you want your school’s timetable data to be automatically imported into Schoolbox from your external system.
    Note: This runs every day of the week.
    This scheduled import ensures that any timetable updates made in your source system are reflected in Schoolbox each day.
    Timetable data updates are not immediate. They typically take around 15–20 minutes to appear in Schoolbox, though in some cases, it may take longer.
    Note: This field only affects the import of timetable data.
     
  6. To view your current endpoint status and the status of previous imports, scroll beyond the API configuration: image.png
     
  7. Select 'current endpoint status' for a detailed view of the status of each endpoint and node as required.
    Note: The 'Previous Imports' section will vary based on the SIS and API configuration used. 
Back To Top
  • The School User Data Store (SUDS) and its Schema

Wonde & GeoSnapShot Photo Redaction

Are you sure you want to remove this component?

The School User Data Store (SUDS) has a field 'Photo Redacted'. 

Wonde will populate this field with a '1' based upon the field 'photograph_student' field that can be used for: "Have the parents given photograph student permission.".

Back To Top