Developer API

Build on Elymica.

Integrate enrollment, course delivery, payments, and analytics directly into your tools and workflows. A RESTful API built for education systems.

REST

API Style

Bearer

Auth

6

Resource Groups

JSON

Response Format

What you can build

API resource groups

Six resource groups covering every part of the Elymica platform.

Auth

Authentication & Sessions

Token exchange, two-factor validation, session management, and single sign-on flows.

12 endpoints

Sch

Tenants & Schools

Create and configure schools, manage admin users, and customise portal branding.

9 endpoints

Crs

Courses & Content

Browse the course catalog, stream lesson content, query curriculum alignment nodes.

18 endpoints

Enr

Enrollment & Access

Bulk-enroll students, manage school licenses, check and revoke access.

11 endpoints

Pay

Payments & Billing

Initiate payment flows, query subscription status, and retrieve billing history.

8 endpoints

Whk

Webhooks & Events

Subscribe to real-time events: enrollment confirmed, payment completed, lesson progress.

7 endpoints

Quick start

Your first API call

List available courses for your school in under a minute.

Request

curl https://marketplace.elymica.com/api/courses \
  -H "Authorization: Bearer <your_token>" \
  -H "X-Tenant-Slug: your-school" \
  -G -d "curriculum=CBE-KE" \
     -d "grade=4"

Response

{
  "data": [
    {
      "id": "crs_KGhP3A",
      "title": "Grade 4 Mathematics",
      "curriculum": "CBE-KE",
      "grade": 4,
      "publisher": "Cardinal Education Network",
      "license_type": "school",
      "price_kes": 4500
    }
  ],
  "meta": { "total": 47, "page": 1 }
}

Security

Authentication

Tok

Bearer token authentication

All API requests require a bearer token in the Authorization header. Tokens are scoped to your school or publisher account and expire after 24 hours. Refresh tokens are available for long-running integrations.

Ten

Tenant-scoped requests

Pass your school slug in the X-Tenant-Slug header to scope all requests to your institution. Requests without a valid tenant header return 401. Multi-tenant access is available for district-level Enterprise accounts.

Who can use it

API access tiers

API access is available on Enterprise plans and through the certified partner programme.

Enterprise

Full read/write API access across all resource groups. Webhook delivery included.

Publisher Pro

Read-only access to course catalog and royalty analytics endpoints.

Certified Partners

Full API access granted through the Elymica integration partner programme.

Get started

Ready to integrate?

Contact our team to request API access or ask about our integration partner programme.