API Overview

KoAkademy’s API is beta. Only the routes listed here are a documented integration surface:

Authentication	Method and path	Purpose
Optional feature, public	`GET /api/v1/public/settings`	Selected public website settings
Laravel Sanctum	`GET /api/settings` and settings routes	Read and manage general settings
Laravel Sanctum	`POST /api/students/verify`	Match a student ID and email

Routes that exist in the application but are not listed here are internal and may change without a public compatibility guarantee. In particular, KoAkademy does not publish a student CRUD API contract.

Base URL

Use the configured application origin and /api, for example:

https://school.example/api

Do not substitute a fictional shared KoAkademy API hostname; self-hosted installations serve their own API.

Authentication

Protected routes use Laravel Sanctum. Clients with a token provisioned by their operator send:

Authorization: Bearer YOUR_TOKEN
Accept: application/json

Token issuance and revocation are deployment responsibilities. No public token-creation endpoint is documented in this release. Never put tokens in source code, browser logs, URLs, or public issue reports.

Stability and errors

Requests and responses use JSON and normal HTTP status codes. Callers must handle at least 401 for missing/invalid authentication, 403 for denied actions, 404 for missing or disabled resources, and 422 for validation errors.

Field-level compatibility is limited to examples covered by endpoint tests. Pin the latest stable KoAkademy version and verify integrations in staging before upgrades.

Continue with Authenticated settings or Student verification.