API Overview

Security: Keep your API key secret. Do not expose it in client‑side code. For production, we recommend sending it as a POST parameter or custom header (future release).

Obtaining an API Key

1. Log in as an Admin.
2. Go to Settings → API Clients (available on paid plans).
3. Click Create New Client.
4. Enter a name (e.g., “My Academy”).
5. The system generates an api_key and webhook_secret.
6. Save these securely – the secret is shown only once.

Note: API access is available on School Plan and higher (or via custom enterprise agreement).

Rate Limits

• Default limit: 60 requests per minute per API key.
• Exceeding the limit returns HTTP 429 with a Retry-After header.
• Higher limits available upon request (contact support).

Response Format

All successful responses follow this structure:

{
"success": true,
"message": "Optional human‑readable message",
"data": { ... }
}