Step-by-Step

Guides & Use Cases

Real-world integration walkthroughs that go beyond endpoint reference. Learn when and why to use specific APIs, see realistic examples, and ship faster.

6 availableHands-onProduction-ready

What you'll learn

These guides demystify API capabilities, explain real-world behaviors, and show how different options can be used together to drive efficiency, automate workflows, and reduce reliance on manual admin actions.

When and why to use a specific endpoint

Required vs optional fields and platform behavior

Common patterns, edge cases, and validation rules

Realistic request and response examples you can adapt

Related training5 min

API Fundamentals -- Thought Industries Academy

A 5-minute course on Thought Industries Academy covering the basics of API fundamentals.

Available Guides

Pick a scenario that matches what you're building. New guides are added regularly.

Available

Creating and Updating Courses via API

A deep, end-to-end walkthrough of one of the most common and foundational integration use cases. Learn how to create and update courses programmatically, understand required vs optional fields, and handle validation rules.

When and why to use the course creation endpoint
Required vs optional fields and how they affect platform behavior
Common patterns, edge cases, and validation rules
Realistic request and response examples

Read guide

Available

External Ecommerce Integration

Redirect learners to an external cart for purchases, then provision access upon successful transactions using JWT, APIs, or SSO.

Configuring external cart redirect flows
Handling purchase callbacks and transaction verification
Provisioning learners and content via JWT, API, or SSO
Mapping purchased products to courses and learning paths

Read guide

Available

Ecommerce 2.0 Multi-Currency Data Extraction

Extract user, product, and multi-currency pricing data from the platform using GraphQL and window.CONF.preload for integration with external ecommerce systems or BI tools.

Accessing user data and preferred currency from window.CONF.preload
Fetching multi-currency pricing via GraphQL
Matching prices to user's selected currency with fallback logic
Sending structured ecommerce data to external systems

Read guide

Available

SSO Integration

Set up Single Sign-On to provide seamless authentication for your learners. Connect your identity provider with Thought Industries.

SAML and OIDC configuration
User provisioning flows
Role mapping strategies

Read guide

Available

Webhook Configuration

Receive real-time notifications when events occur in the Thought Industries platform. Configure webhooks for enrollments, completions, and more.

Webhook endpoint setup
Event types and payloads
Retry logic and error handling

Read guide

Available

Bulk Operations

Efficiently manage large-scale data operations: bulk user creation, course assignments, and data imports.

Batch API patterns
Rate limit management
Error handling for bulk operations

Read guide