Concepts
To provide the highest possible level of security and data segregation, authenticating to the Xporter API works differently to some other APIs that you may have encountered.
Token Types - An Overview
There are two types of token that you can generate:
Management API Tokens
The Xporter REST API supports token authorisation using a custom bearer style Authorization header.
School API Tokens
The Xporter REST API supports token authorisation using a custom bearer style Authorization header.
Inviting Schools
To streamline your onboarding process, we have created an API that allows you to programmatically invite a school to share data with your application. Schools can trigger this process themselves from within your application.
Processing Secrets
Processing Successful Data Authorisations
Validating Secrets
Once you receive a secret you should validate it by attempting to generate a token and checking the resultant token contents.