Documentation

API guides, references, and examples — ported from the classic Connect docs library.

Long-form SCORM API documentation lives under docs/scorm-api/ and is readable at /docs/scorm-api/…. Pair it with the interactive OpenAPI UI and machine-readable contracts for implementation work.

Browse strategy

Start with a guide, then validate in Swagger.

Narrative docs explain behavior and edge cases; OpenAPI and contract routes describe the exact surface area.

Suggested order
Quick start → architecture → your integration path (LMS, dispatch, or WordPress) → security → webhooks.

Quick start

Get up and running in minutes with the getting-started path: account, package, session, and reports.

Open

Interactive API reference

OpenAPI 3.1 with Swagger UI — try endpoints, filters, and schemas in the browser.

Open

Code examples

Ready-to-use samples and patterns for common integrations.

Open

API documentation library

Sections (from the classic docs hub)

These mirror the categories from the previous Allure Connect documentation site; content is Markdown in the repository and renders at each slug URL.

Security & best practices

API keys, rate limits, errors, and security posture.

Advanced topics

Webhooks, performance, scaling, and deep integrations.

More resources

Contracts, inventory, and internal notes

Contact support

Questions about implementation or billing? Reach the team directly.

Email info@allureconnect.com

FAQ

Quick answers to common API and integration questions.

View FAQ

Ready to build?

Get your workspace and API keys, then upload packages and validate launches end to end.

Start checkout