API Key

API Key


Overview

Your Compass API Key (Application Program Interface) allows a number of programs to push from and pull data to from Compass. It is most commonly used with timetabling programs that use the LISS specification, such as edval and Timetabling Solutions V9 as well as CeD3 program.

API keys are unique to each user and tied to their Compass Username.

Permissions

Users with the ImportData or CompassApiUser permissions will have and be able to access their API Key.

For further information on assigning permissions in Compass, please refer to the Permissions article from our Knowledge Base.

Finding your API Key

To find your API Key, click Tools (Cog icon) and then select 'Login and Security'.

Your API Key details will show at the bottom of the page under any listed device information.

     

Resetting your API Key

If you need to reset your API Key, click the 'Reset API Key' option.

     


If you accidentally share your API Key or believe someone else has gained access to it, please reset your API Key immediately.

Please note that resetting your API Key will require you to reconfigure anything that you have setup with your previous API Key. 


    • Related Articles

    • PaperCut Integration

      Overview Compass now integrates directly with PaperCut using CompassLink. The previous method of integrating via the SUSSI Service is no longer supported. While most schools use CompassLink already for authentication with Compass, this article will ...

    • Individual Permissions

      Permissions To provide your users with the appropriate access within your portal we have created Compass Permission Groups with their own set of individual Default and School-Defined permissions. The Permission Groups are managed in your Compass ...

    • Beginning with Compass

      Beginning with Compass This article collates the applicable supporting articles of aspects covered in the school's inital training session when first commencing with Compass as an easy reference guide. It is also useful if you are a new member of ...

    • Rapid Receipting

      Overview Compass's Rapid Receipting function allows you to import the details of all payments that have been made through CompassPay directly into CASES21, allowing quick allocation of each payment to the relevant outstanding payment item. The ...

    • Webinar Library

      Overview We have a range of webinar recordings available for staff at your school to access to assist them with using a range of modules available within Compass. Webinar recordings provide great flexibility as you can watch the video whenever it ...