For developers
One integration API. Every client uses the same endpoints, and supported and planned parts are listed separately.
Shape of the API
- Base path
/v1, JSON, UTF-8. Authorization: Bearer <credential>. An integration credential is an institution API key held on a server. A learner session token is short-lived and is minted by an integration.- The institution comes only from the credential. No request field can select another institution.
- Writes carry stable ids and are idempotent. A retry with the same id returns
duplicate. acceptedmeans stored only. It never means evaluated, mastered or passed.- Clients cannot assert correctness, grades or authority.
Supported and planned
| Capability | Status | Notes |
|---|---|---|
Identity and discovery: GET /v1/whoami and GET /v1/capabilities |
Built in source, not in service | Reviewed API-key authentication. Not in service. |
| Integration API v1 operations: actor bindings, learner sessions, catalog reads, deliveries, uploads, evidence batches, attendance, lesson conclusions, self-report and policy | Built in source, not in service | The capabilities read reports these as implemented in source. Not in service and not publicly available. |
| LTI 1.3 tool launch | Built in source, not in service | Moodle is the planned reference platform. No LMS has been connected. |
| cmi5 launch and SCORM 1.2 launch | Built in source, not in service | Not running publicly. |
| xAPI statements emitted to the platform's own private record store | Built in source, not in service | The record store service is not yet qualified or activated. It is an internal engine and exposes no endpoint to clients. |
| Offline-capable JavaScript SDK and reference runner | Built in source, not in service | Not published as a package. Not checked in real browsers. |
| Standard xAPI endpoint for external producers (xAPI 2.0 and 1.0.3) | Planned, not built | No conformance is claimed. |
| Open Badges 3.0 and Comprehensive Learner Record credentials | Planned, not built | Verified credential issuing is also a planned optional service. |
| Grade publication back to institutions | Planned, not built | Reported as not implemented by the capabilities read. |
| Gamification: ledger, rewards, halls and championships | Planned, not built | Requirements exist. Nothing is built. |
Clients
iMagine Playground and the bundled reference runner are ordinary clients. They use the same endpoints as any third-party client, with no privileged path. Learner apps never receive the institution key, only a short-lived session token minted by the integration's own server.
No certification or conformance claim
GAMERIZE does not claim certification or conformance to any standard. Wording such as "conforms to … tested with …" will be published only together with the executed evidence behind it. None exists yet.
Documentation
The agreed integration contract (version 1, revision 0.3) lives in the project repository. No hosted documentation exists yet, so this page links to none.