Skip to main content

Token Types - An Overview

There are two types of token that you can generate:

TypeDescription
SchoolProvides access to School Data APIs
ManagementProvides access to Management and Automation APIs

Tokens contain the information Xporter needs to determine what data and services your application has access to - what you are authorised for.

Management API Token

A managementSecret is issued to you following initial registration of your application.

Tokens generated with a managementSecret are used for management and automation APIs which do not require access to school level data. You can find more information on generating and using this token in the next section, Management API Tokens. A full list of APIs you can access with this token can be found at https://api.xporter.com.

tip

To request a new managementSecret please contact our service team.

School API Tokens

When a school authorises your application, a unique schoolSecret is issued that is needed to generate a Token.

If a school authorises your app a second time, you will be issued with a new schoolSecret and a new Token should always be generated. More details on schoolSecrets and how to use them to generate a Token can be found in the later section, School API Tokens. A full list of APIs you can access with this token can be found in the API Reference section.

tip

Important: You will be issued a unique schoolSecret for each school that authorises your application.