Page Introduction

Workshop onboarding track

This onboarding sequence validates API key handling, auth, and bearer-token calls before production feature development.

  • Complete all steps in order to reduce integration risk.
  • Verify both successful and failing auth scenarios.
  • Move to namespace docs only after auth and token flow is stable.

Get Started

Workshop API onboarding

Use this onboarding track to go from first API key setup to validated authenticated Workshop API calls. Complete the four steps in sequence, then continue into namespace-level implementation.

4Onboarding steps
3API domains
2026-02-16Canonical source

How this onboarding is structured

Follow the sequence

Run steps 1 to 4 in order. Each step removes a common integration risk before you move to protected business endpoints.

Validate with interactive tools

Use Auth Interactive and Workshop Interactive to verify headers, payloads, and responses before frontend rollout.

Step-by-step onboarding

Production onboarding flow for Workshop API integration.

01

Step 1: Get your API key

Request the key, configure environments, and validate access in a safe setup.

Open step
02

Step 2: Add API key to requests

Use `x-api-key` correctly, apply request defaults, and handle common failures.

Open step
03

Step 3: Run Auth testing

Validate sign-in, refresh-token, logout, and proxy behavior before feature rollout.

Open step
04

Step 4: Call protected endpoints

Use Bearer token flow for workshop endpoints and confirm protected reads/writes.

Open step

What APIs to expect

After onboarding, continue with these namespace groups for full feature implementation.

Deep dive after onboarding

Move from guided onboarding into full endpoint reference and interactive testing.