Design principles
Resource-oriented
Predictable endpoints for people, applications, students, programmes, invoices and more.
Scoped credentials
API clients are designed to receive only the permissions they need, and to be revocable at any time.
Versioned
Breaking changes are introduced in new versions with deprecation notice.
Rate-limited
Fair-use limits protect platform performance for everyone.
Audited
API access is logged like user access.
Sandbox
Test against a sandbox environment before production.
Common use cases
| Use case | Approach |
|---|---|
| Website application forms | Submit enquiries or applications directly from your website |
| Data warehouse | Read data on a schedule for institutional analytics; see data export |
| Custom portals | Build specialised experiences on top of Acadlytic data |
| Partner systems | Exchange data with approved partners under agreed scopes |
Frequently asked questions
Is there an API for our website forms?
Yes, that is the plan. Enquiry and application endpoints let your website submit directly to Acadlytic, with validation and spam protection.
How do we get API credentials?
Administrators create API clients with specific scopes in a sandbox first, then in production after testing.