Welcome! This hub collects all the essential resources for building against the Class API. Start with the quickstart, then dive into authentication flows (Authorisation Code, Resource Owner Password), refresh tokens, scopes, error handling, and our API structure.
Get set up and make your first successful request in minutes.
- Using the API — environment setup, base URL, headers, a first “hello” call, and troubleshooting tips.
Learn how users and apps obtain tokens to call the Class API securely.
- Auth Overview — Identifying which flow to implement (Partner vs. Client)
- Authorisation Code Flow — recommended OAuth 2.0 flow for web/native apps.
- Resource Owner Password Flow — legacy/edge case flow.
- Refresh Tokens — how to obtain/rotate refresh tokens.
- Authorisation Scopes — available scopes and least-privilege examples.
- UserInfo Endpoint — retrieving the authenticated user’s profile.
- SSO using Class API — high-level SSO patterns.
- Class API Structure — service domains, resource naming, versioning strategy.
- Rate Limiting — limits, headers, and retry/backoff guidance.
- Error Codes — error taxonomy and actionable remediation.
- API Reference — full OpenAPI reference.