Compass API

To access Compass' documentation on generating an API Key:

1. Navigate to your instance of Compass.

2. Append '/ApiDocs/Documentation/index.html' to the URL.

1. Log in to Schoolbox.

2. Navigate to Administration > School Data Import > Home.

3. Select data source as 'Compass'.

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 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 Compass Configuration Key.

8. Select Save.

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

1. Navigate to Administration > School Data Import > Home.

2. Select the 3-dot Menu and select 'Perform Live Update'.

To view your current endpoint status and the status of previous imports.

1. Scroll beyond the API configuration.

2. 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 upon the SIS and API configuration used.