FSA LMS Partner API Documentation¶
Documentation v3.5 · Implementation-verified · Last updated 2026-10-15
Welcome to the Fire Safety Academy (FSA) Learning Management System Partner API documentation. This API lets your LMS deliver 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.
Explore the API: interactive docs (Swagger UI)
Browse every endpoint, its parameters and its response shapes in the interactive reference: sandbox.lms.api.fsri.org/api/partner/v1/docs
Most developers start there. The pages on this site add what Swagger can't show: how to authenticate, the order to call things in, and how to embed content.
Ready to get started?
The next step is working with our team to sign a licensing agreement. Contact the Help Desk for more details.
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 · Move to production | Production credentials issued by FSRI; swap base URL and launch | days |
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, passing scores, and course artwork |
| 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 interactive content |
| Progress tracking | Read per-user course progress, created automatically on first content access |
| Completion | Report completion for video/document content; interactive content 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 |
| Go-Live Runbook | Moving from sandbox to production: checklist, launch day, first two weeks |
| Rate Limits & Plans | Usage plans and how to stay inside yours |
| Support & Escalation | Who to contact, what to send, reporting a security issue |
| FAQ | Common questions, answered |
| Code Examples | curl, Python, PHP, JavaScript, Postman |
Environments¶
| Sandbox | Production | |
|---|---|---|
| API base URL | https://sandbox.lms.api.fsri.org/api/partner/v1 |
https://lms.api.fsri.org/api/partner/v1 |
| Token URL | https://fsri-partner-api-sandbox-357795418386.auth.us-west-2.amazoncognito.com/oauth2/token |
https://fsri-partner-api-prod-357795418386.auth.us-west-2.amazoncognito.com/oauth2/token |
| Content host | https://partner-courses.sandbox.lms.fsri.cloud |
https://partner-courses.prod.lms.fsri.cloud |
Every example on this site uses sandbox, so code you copy can't reach production by accident.
Credentials are environment-specific and non-transferable, and they are issued privately by FSRI, never published here. Endpoint paths are identical in both environments: a working sandbox integration moves to production by swapping the base URL, token URL and credentials. See the Go-Live Runbook.
Questions? See the FAQ. Partners can contact their FSRI integration contact; anyone else, the Help Desk.