FSA LMS Partner API Documentation¶
Documentation v3.4 · Implementation-verified · Last updated 2026-07-26
Welcome to the Fire Safety Academy (FSA) Learning Management System Partner API documentation. This API lets your LMS deliver UL FSA fire-safety training — catalog, content playback, progress, completion, and certificates — inside your own platform, with your users never leaving your application.
You keep full ownership of your user experience. Your LMS talks to the API server-to-server; FSRI hosts the content and owns the learning record.
The Path to Production¶
| Phase | What happens | Typical duration |
|---|---|---|
| 1 · Get access | Partner agreement signed, sandbox credentials issued by FSRI | days |
| 2 · Build in sandbox | Integrate the full learner flow against live content | 2–4 weeks |
| 3 · Get certified | Demonstrate the five certification scenarios | ~1 week |
| 4 · Go live | Production credentials, smoke test, launch | days |
Full detail: Onboarding Checklist.
Start Here¶
- Quick Start Guide — first API call in under 5 minutes
- Authentication — the two-credential model every request uses
- API Reference — every endpoint with request/response examples
Have your credentials?
Enter your Client ID and API key in the credentials panel on the Quick Start page and every code sample across this site fills itself in. Values stay in your browser only.
What the API Provides¶
| Capability | What you can do |
|---|---|
| Content catalog | List organizations, categories, courses, and modules — with descriptions, durations, and passing scores |
| User management | Register your learners (each gets a UUID), read/update profiles, deactivate, or permanently remove (GDPR-compliant) |
| Content delivery | Request signed, time-limited content URLs and embed them in your player — FSRI hosts and renders SCORM |
| Progress tracking | Read per-user course progress, created automatically on first content access |
| Completion | Report completion for video/document content; SCORM reports its own |
| Transcripts & certificates | List completions and download certificate/transcript PDFs |
Documentation Index¶
| Document | Description |
|---|---|
| Quick Start | Credentials → token → first call → registered test user |
| Authentication | OAuth2 client credentials + API key, token lifecycle, security |
| Conventions | Response format, field naming, pagination, delta sync, X-User-ID |
| API Reference | All endpoints with examples |
| Workflows | The canonical integration flow, step by step |
| Error Handling | Debug checklist, every status code, retry strategy |
| Onboarding Checklist | The full path from agreement to production |
| Certification | The five scenarios required before production access |
| FAQ | Common questions, answered |
| Code Examples | curl, Python, PHP, JavaScript, Postman |
Environments¶
| Environment | Base URL |
|---|---|
| Sandbox | https://sandbox.lms.api.fsri.org/api/partner/v1 |
| Production | https://lms.api.fsri.org/api/partner/v1 (post-certification) |
Interactive API docs (Swagger UI): sandbox.lms.api.fsri.org/api/partner/v1/docs
Credentials are environment-specific and non-transferable. Endpoint paths are identical in both environments — a working sandbox integration moves to production by swapping base URL and credentials.
Partner Area¶
Contracted partners get access to the Partner Area — support contacts and escalation SLAs, your rate-limit plan, and the go-live runbook. Access credentials are issued with your partner agreement.
Questions? See the FAQ, or contact your FSRI integration contact.