meta data for this page
This is an old revision of the document!
Developer & Integration Guide
This guide covers the LEAST platform's integration surface for developers and system integrators.
Contents
- API Authentication — credentials, tokens, and auth flow
- Collection API Reference — full function reference
- API Cookbook — practical recipes: bulk ops, webhooks, automation, code examples
- LTI 1.3 Integration — connecting a VLE to LEAST as a Tool Provider
- Webhooks — event-driven notifications
- xAPI & SCORM — statement dispatch and SCORM tracking
- Building Collections — designing custom data structures
Platform Overview
LEAST is a server-rendered PHP application. Its external integration surface is:
| Interface | Protocol | Primary use |
|---|---|---|
| Collection API | HTTPS POST, JSON | Read/write collection records, automate workflows |
| LTI 1.3 | OIDC + JWT | VLE integration (Moodle, Canvas, etc.) |
| Webhooks | HTTPS POST, JSON | Event notifications to external systems |
| xAPI | HTTPS POST, JSON-LD | Learning activity dispatch to an LRS |
Base URL
All API calls go to: https://wherewelearn.com/api/apic.php
Getting Credentials
API credentials (username and key) are set on a user account by a Level 3 administrator. See User Management → API Credentials.
Quick Start
New to the API? Start with Basic Recipes in the cookbook — it has copy-paste examples for every common operation.