Back to DocumentationAPI Reference

Frequently Asked Questions

Frequently Asked Questions

Common questions and answers about the AllureLMS SCORM API.

Table of Contents

General Questions

What is the SCORM API?

The AllureLMS SCORM API is a RESTful API service that enables you to upload, manage, and play SCORM 1.2 and SCORM 2004 packages. It provides session management, progress tracking, and analytics.

What SCORM versions are supported?

  • ✅ SCORM 1.2 (full support)
  • ✅ SCORM 2004 (1st-4th Edition, full support)
  • ❌ AICC (not supported)

How do I get started?

See the Quick Start Guide for step-by-step instructions.

What are the API rate limits?

  • Default: 100 requests per minute per tenant
  • Higher limits available on premium plans
  • See Rate Limiting Guide for details

Is there a free tier?

Yes! The free tier includes:

  • Limited package storage
  • Basic API access
  • Standard rate limits
  • Community support

Package Questions

What file formats are supported?

Only ZIP archives containing SCORM packages are supported. The ZIP must contain:

  • imsmanifest.xml (SCORM manifest)
  • Course content files
  • Valid SCORM structure

What is the maximum package size?

How long does package processing take?

Processing time depends on package size:

  • Small packages (<10MB): 10-30 seconds
  • Medium packages (10-100MB): 30-120 seconds
  • Large packages (100MB-1GB): 2-10 minutes
  • Very large packages (>1GB): 10-30 minutes

Can I update a package without losing sessions?

Yes! Upload a new version to the same package ID. Existing sessions can continue with the old version, or you can force all sessions to use the new version.

What happens if package processing fails?

You'll receive a webhook notification (if configured) or can check the package status. Common failure reasons:

  • Invalid SCORM manifest
  • Missing required files
  • Unsupported SCORM version
  • Storage quota exceeded

Session Questions

How long do sessions last?

Sessions expire after 24 hours of inactivity by default. You can extend this by updating the session.

Can learners resume sessions?

Yes! Check for existing incomplete sessions before creating new ones. The API supports session resumption.

How do I track learner progress?

You can:

  1. Poll session status - Check session periodically
  2. Use webhooks - Get notified of completion events
  3. Query session data - Get current progress anytime

See First Session Guide for details.

What is a version conflict error?

Version conflicts (409) occur when multiple processes try to update the same session simultaneously. Implement retry logic with optimistic locking. See Troubleshooting Guide.

Can I update CMI data programmatically?

Yes! Use the session update endpoint. Always include the version field for optimistic locking.

Integration Questions

How do I integrate with my LMS?

See integration guides:

Do I need special SCORM knowledge?

Basic understanding helps, but the API handles most SCORM complexity. You mainly need to:

  • Upload packages
  • Launch sessions
  • Track progress

Can I use this with my existing LMS?

Yes! The API works with any system that can make HTTP requests. Many LMSs can integrate via:

  • Custom plugins
  • API integrations
  • Dispatch packages

How do webhooks work?

Webhooks send HTTP POST requests to your endpoint when events occur. See Webhook Setup Guide.

Billing & Quotas

What are the storage limits?

Storage limits vary by plan:

  • Free: 1GB
  • Professional: 50GB
  • Enterprise: Custom limits

What happens if I exceed my quota?

You'll receive notifications and new uploads will be blocked. Options:

  • Delete unused packages
  • Upgrade your plan
  • Contact support for custom limits

How is usage calculated?

Usage includes:

  • Package storage (total size of all packages)
  • API requests (all API calls)
  • Session storage (CMI data)

Can I get a custom plan?

Yes! Contact sales for custom plans with:

  • Higher quotas
  • Custom rate limits
  • Dedicated support
  • SLA guarantees

Technical Questions

What authentication methods are supported?

Two methods:

  1. API Key - For server-to-server (programmatic access)
  2. Clerk - For web application users (browser-based)

See Authentication Guide.

How is data isolated between tenants?

Multiple layers:

  • Row Level Security (RLS) at database level
  • Automatic tenant filtering in API
  • Storage path isolation
  • No cross-tenant access possible

See Data Isolation Guide.

What programming languages are supported?

Any language that can make HTTP requests! Examples provided for:

  • TypeScript/JavaScript
  • Python
  • PHP
  • And more

See Code Examples for examples.

Can I use this on-premises?

The SCORM API is a cloud service. For on-premises deployment, contact enterprise sales.

How do I handle errors?

All errors follow a consistent format:

{
  "error": "Human-readable message",
  "code": "ERROR_CODE",
  "details": {}
}

See Error Codes Reference.

What is optimistic locking?

Optimistic locking prevents data loss when multiple processes update the same session. Always include the version field when updating sessions. See Session Management.

Still Have Questions?

Last Updated: 2025-01-15