Developer resources / v1

SCORM Player API

A starting point for the SCORM Player platform.
Explore the available endpoint below.

Base URL

{{ url('/api/v1') }}

Responses use JSON. Send an Accept: application/json header when calling the API.


Authentication

The health endpoint is public. Local password login at /login is restricted to superadmins. When configured, members can use Continue with DocuDeck to create a separate player session. Password-based user API authentication is not available.

GET /api/v1/health Public

Check that the application is responding. No parameters or authentication required.

Example request

curl -H "Accept: application/json" \
  {{ route('api.health') }}

Response 200 OK

{
  "status": "ok",
  "service": "scorm-player",
  "version": "1.0"
}
Open health endpoint ↗

SCORM upload, playback, and progress tracking are planned for future stages. DocuDeck sign-in is available when the integration is enabled.