API reference

Use the API reference to send requests, inspect responses, and implement SD Platform workflows without wading through narrative material.

Base URL: https://api.simplestdata.com
Version: v1 Current
Client libraries: Ruby
Python
PHP
Java
Node.js
Go
.NET

Introduction

The SD Platform API is organized around learning activity, modeling, ingestion, and operational visibility. Use sandbox credentials while testing and keep production credentials isolated by environment.

Authentication

Authenticate every request explicitly. Keep environment-specific credentials separate so sandbox testing cannot leak into production rollout work.

Errors

Errors focus on malformed payloads, rejected credentials, unsupported routes, and retry behavior that callers can observe directly from the public contract.

Request IDs

Request IDs help integration teams correlate a client-side failure, an API response, and a support conversation around the same call.

Statements

Statements represent learning activity events sent into SD Platform. They are the primary write surface for xAPI-style activity data.

Statements

curlJavaScriptPython

bash

curl https://api.simplestdata.com/v1/statements \
  -H "Authorization: Bearer $SD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "actor": {
      "mbox": "mailto:learner@example.edu"
    },
    "verb": {
      "id": "http://adlnet.gov/expapi/verbs/completed"
    },
    "object": {
      "id": "https://example.edu/activity/module-intro"
    }
  }'

Profiles

Profiles document the event semantics and validation rules that keep separate emitters aligned as data moves into shared reporting surfaces.

Sessions

Session-oriented resources help teams reason about multi-event launches, resumptions, and durable context across a learner workflow.

Ingress

Ingress coverage explains what happens at the point of receipt: accepted payloads, rejected payloads, and operational expectations around retries.

Observability

Observability guidance makes it easier to diagnose failed requests, unexpected validation outcomes, and downstream delivery issues without exposing internal architecture.

Versioning

Versioning guidance explains how SD Platform introduces request or response changes, what callers can pin, and how preview behavior is communicated.