Skip to content
Blend-ed Docs

BlendX discovery APIs

Connect a storefront or partner system to the Blend-ed catalog. Discover courses and programs, resolve organisation branding and pricing, complete guest or learner checkout, and grant access after payment.
Get started View on GitHub

What you can build

Section titled “What you can build”

Course discovery

List and search published courses, load course details and outlines, filter by organisation or tag, and display modes, reviews, and regional prices.

Programs and organisations

Discover programs and their courses, browse organisations, and load the branding and marketing metadata required by a multi-organisation catalog.

Storefront checkout

Start checkout for a guest or signed-in learner. Free items bypass the payment provider; paid items use the organisation’s configured gateway.

Enrollment integrations

Let a trusted partner system grant or remove course access by email after it confirms payment outside Blend-ed.

Base URL

Section titled “Base URL”

All routes in this guide are relative to the LMS:

https://<LMS_HOST>/blendxapi/

The APIs are provided by the blendxapi Django app, version 4.0.0 in the documented checkout. They depend on the BlendX Hasura metadata service for catalog, organisation, cart, transaction, and enrollment records.

Storefront lifecycle

Section titled “Storefront lifecycle”
  1. Load organisations, tags, courses, or programs from /discovery/.
  2. Use the returned course or program UUID and organisation UUID in checkout.
  3. Check /discovery/user/ to choose guest or authenticated checkout.
  4. Complete payment using the gateway-specific values returned by checkout.
  5. Let the signed payment webhook mark the purchase and create enrollment.
  6. For an external checkout, call /enrollments/client/enroll/ only after the external system confirms payment.

Choose a guide

Section titled “Choose a guide”
Quickstart Make a first catalog request and understand the identifiers.
API reference See every supported discovery, checkout, and client-enrollment endpoint.
Authentication Use a learner identity or the server-side client credential.
Courses List, filter, and load course details, outlines, effort, and enrollment state.
Programs List programs, load program details, and discover their courses and tags.
Organisations Build organisation filters and branded marketing pages.
Checkout Integrate guest, authenticated, and cart-backed checkout flows.
Enrollment Grant or revoke access from a trusted external system.