BrainCert LMS API: Developer Guide

The BrainCert LMS API allows you to integrate, automate, and extend the capabilities of your BrainCert LMS instance. With this API, you can programmatically manage users, groups, courses, live classes, bundles, tests, products, discounts, and more.

This guide focuses on two essentials:

1. How to generate and use your API key (with Domain ID).

2. The complete list of supported API calls across all LMS resources.

Generating an API Key

Log in to your BrainCert LMS Admin Dashboard. Go to Global Settings → Basic Settings→ Create API Keys.

Copy the API Key and your Domain ID, and keep them secure.

API Endpoints (Supported Calls)

The BrainCert LMS API v1 provides a wide range of endpoints to manage your LMS resources. To make navigation easier, the endpoints are grouped into categories. Each category represents a type of resource (such as users, courses, or tests) and contains the common actions you can perform.

Users

Groups

Courses

Live Classes

Bundles

Tests

Products & Categories

Shopping Cart & Pricing

Discounts

Gamification

Authentication Example

Every request to the BrainCert LMS API must include two authentication headers:

• Authorization: API_KEY → Your unique API key

• x-domain-id: DOMAIN_ID → The Domain ID of your LMS instance

Both must be sent with each request to ensure the API can verify who you are and which LMS instance you’re accessing.

Example: Create a User (cURL)

curl -X POST "https://lms.braincert.com/api/v1/users/create" \
  -H "Authorization: API_KEY" \
  -H "x-domain-id: DOMAIN_ID" \
  -H "Content-Type: application/json" \
  -d '{"username":"testuser","email":"test@example.com"}'

{
  "message": "User successfully created",
  "id": 12345
}

{ "message": "Bad Request", "error": { "code": 400, "details": "<reason>" } }

API Basics: Getting Started

The BrainCert LMS API allows you to manage users, courses, tests, and more through simple REST endpoints. This section covers the fundamentals to help you quickly start building with the API.

API (Application Programming Interface)

An API is like a waiter in a restaurant. You (the client) tell the waiter what you want, and they bring your request to the kitchen (the server) and return your food (the response).

In software, an API lets different programs talk to each other. Instead of manually clicking in a web app, you send requests to the API, and it gives you structured data back.

Endpoint

An endpoint is a specific URL in the API that performs a certain function.
For example:

• /users/create → Create a user

• /courses/list → Get a list of courses

Think of endpoints as doors leading to different services inside the LMS.

JSON (JavaScript Object Notation)

JSON is a lightweight format for sending data. It looks like a dictionary or a table, but written in a way computers can easily understand.

Example JSON:

{
  "username": "alice",
  "email": "alice@example.com"
}

This is easier for systems to exchange data than plain text.

HTTPS

HTTPS (HyperText Transfer Protocol Secure) is the secure way of sending requests over the internet. It encrypts your API calls so nobody can see your API key, Domain ID, or user data while it’s traveling between your app and BrainCert’s servers.

API Key

An API Key is like a secret password that proves you are allowed to use the API. Every request you send must include your key, or the API will reject you.

Domain ID

The Domain ID tells BrainCert which LMS instance you are working with (since BrainCert can host many). It’s like telling the post office which street your house is on, so they don’t deliver your mail to the wrong place.

Request vs. Response

• Request → What you send to the API (includes endpoint, headers, and JSON data).

• Response → What the API sends back (usually JSON).

Example request:

POST /users/create
{ "username": "alice", "email": "alice@example.com" }

Example response:

{ "message": "User successfully created", "id": 12345 }

Headers

Headers are extra information sent with a request. For BrainCert APIs you must always include:

• Authorization: API_KEY

• x-domain-id: DOMAIN_ID

These tell the server who you are and which LMS you belong to.

Status Codes

Every API response comes with an HTTP status code:

• 200 → OK, success

• 400 → Bad request

• 401 → Unauthorized (wrong key/domain)

• 404 → Not found

• 500 → Server error

This helps you understand whether your request worked or failed.

Base URL

Most endpoints use the following base URL:

Note: In the examples provided, the base URL is shown explicitly within each section.

Authentication

• API Key: Identify and authorize requests.

• Domain ID: Route the request to your LMS instance.

• Include both as headers on every request:

Authorization: <API_KEY>

x-domain-id: <DOMAIN_ID>

Generate an API key in Global Settings → Basic Settings → API Key in your LMS admin.

Request/Response Format

• Requests: JSON body unless noted.

• Responses: JSON by default.

• Recommended method: POST (even for reads) to protect secrets.

Canonical response envelope

{
"message": "Human-readable status",
"data": { /* object or array, endpoint-specific */ }
}

HTTP Status Codes

• 2xx on success; see Error Reference for failures.

Best Practices

• Use Postman for exploration and collections.

• Use a JSON formatter/extension when viewing responses in a browser.

• Never expose API keys publicly or in URLs.

Common Headers

Response

curl -X POST "https://lms.braincert.com/api/v1/users/create" \
-H "Authorization: $API_KEY" \
-H "x-domain-id: $DOMAIN_ID" \
-H "Content-Type: application/json" \
-d '{"username":"testuser","email":"test@example.com"}'