Back to DocumentationAPI Reference

Quick Start Guide

Quick Start Guide

Get up and running with the AllureLMS SCORM API in under 15 minutes.

Table of Contents

Prerequisites

Before you begin, make sure you have:

  • A SCORM 1.2 or SCORM 2004 package (ZIP file)
  • An account on the SCORM API platform
  • A terminal or API client (curl, Postman, or your preferred tool)

Step 1: Sign Up

  1. Visit the SCORM API website
  2. Click "Get Started" or "Sign Up"
  3. Complete the registration form
  4. Verify your email address
  5. Select a subscription plan (Free tier available for testing)

Note: If you're using the self-hosted version, follow the README setup instructions.

Step 2: Get Your API Key

Via Dashboard (Recommended)

  1. Sign in to your account
  2. Navigate to Dashboard → API Keys
  3. Click "Create API Key"
  4. Give your key a name (e.g., "Development Key")
  5. Select scopes:
    • read: View packages and sessions
    • write: Upload packages and update sessions
    • admin: Full access including deletions
  6. Click "Create"
  7. Important: Copy your API key immediately - it won't be shown again!

Via Admin Script (Self-Hosted)

If you're running a self-hosted instance:

cd apps/scorm-api
./scripts/create-api-key.sh <tenant_id> "Key Name" "read,write"

Step 3: Test Your Connection

Test that your API key works:

curl -X GET https://scorm-api.allurelms.com/api/health \
  -H "X-API-Key: your-api-key-here"

Expected Response:

{
  "status": "ok",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "version": "1.0.0"
}

If you see this response, you're ready to go! 🎉

Step 4: Upload Your First Package

Upload a SCORM package to test the full workflow:

curl -X POST https://scorm-api.allurelms.com/api/v1/packages \
  -H "X-API-Key: your-api-key-here" \
  -F "file=@path/to/your/package.zip" \
  -F "tenant_id=your-tenant-id" \
  -F "uploaded_by=your-user-id"

Expected Response:

{
  "id": "pkg_abc123",
  "tenant_id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Introduction to Safety Training",
  "version": "1.2",
  "launch_url": "index.html",
  "manifest_url": "imsmanifest.xml",
  "storage_path": "tenant-550e8400/packages/pkg_abc123",
  "created_at": "2025-01-15T10:30:00.000Z"
}

What Happens:

  1. The package is uploaded to secure storage
  2. The manifest is parsed and validated
  3. Files are extracted and organized
  4. Package metadata is stored in the database
  5. You receive a package ID for future operations

Processing Time: Typically 10-30 seconds depending on package size.

Next Steps

Now that you've uploaded your first package, continue with:

  1. Launch Your First Session - Create a learning session and launch the SCORM player
  2. Generate Your First Report - View learner progress and analytics
  3. Read the Complete API Guide - Explore all available endpoints (API Reference coming soon)
  4. Check Integration Examples - See how to integrate with your platform

Common Issues

"Invalid API Key" Error

  • Verify you copied the entire API key (they're long!)
  • Check that you're using the correct header: X-API-Key or Authorization: Bearer
  • Ensure your API key hasn't been revoked

"Package Upload Failed" Error

  • Verify your file is a valid ZIP archive
  • Check that the ZIP contains a SCORM manifest (imsmanifest.xml)
  • Ensure the file size is within your quota limits
  • Check the Package Validation Guide for requirements

"Tenant Not Found" Error

  • Verify your tenant_id is correct
  • Ensure your API key is associated with the correct tenant
  • Contact support if you need help finding your tenant ID

Getting Help

Last Updated: 2025-01-15
Related Documentation: