İçeriğe geç
All systems operational — 99.997% uptime
Platform · API 08

REST API, developer-friendly.

200+ endpoints as REST, documented with OpenAPI 3.1, sandbox + production. Scope-based API keys, rate limit headers, webhook + outbox. Theme-kit CLI + storefront-sdk.

200+
Endpoints
REST
OpenAPI
3.1
Fully documented
Sandbox
+ Production
Same API
30+
Webhook events
Signed + outbox
What it does

Developer products, separate from the panel.

Karum's panel stays 100% no-code. Developer needs are served separately via theme-kit CLI + REST + SDK.

REST + OpenAPI

200+ endpoints, OpenAPI 3.1 schema, Swagger UI open on sandbox.

Webhook + outbox

30+ events — order.created, inventory.low, payment.captured. Signed + retry + dead-letter.

TypeScript SDK

(at)karum/storefront-sdk + theme-kit CLI. Full type safety, autocomplete.

Scopes + rate limit

Restricted scopes, per-store tokens, rate limit headers, audit log.

How it works in Karum

Building an integration.

Step 01

Open sandbox

Free sandbox tenant via developers.karumtek.com.

Step 02

Generate API key

Pick scopes (orders:read, products:write...), generate key + secret.

Step 03

Generate client from OpenAPI

TS/Go/Python clients auto via openapi-generator.

Step 04

Wire webhooks

Register endpoint; verify signature; configure retry.

Step 05

Test

Validate the integration with sandbox data; track version changelogs.

Step 06

Go live

Same API + same schema; only the base URL changes.

Feature details

In API, the details we care about.

01
OpenAPI 3.1

Schema-first; all endpoints, request and response types published. Auto-generated SDKs.

02
Sandbox

Free tenant; demo data, isolated, same API as prod.

03
Rate limit

Per-store + per-IP; X-RateLimit-Remaining + X-RateLimit-Reset headers.

04
Versioning

Date-based (2026-04-23). 12-month backward compatibility guaranteed.

05
Outbox pattern

Webhook delivery at-least-once; per-handler ack + dead-letter.

06
Audit log

Every API call + IP + scope + status — append-only.

07
Theme-kit CLI

karum theme push/pull/deploy — theme management via git workflow.

Customer voice
I generated a TS client from the OpenAPI schema in 30 seconds. Thanks to webhook outbox, delivery is at-least-once even if test env crashes.
CY
Can Yıldız
Tech Lead, Headless Studio
Plan coverage

Available on

Starter (read-only) Growth Pro Enterprise (availability guarantee)
See all plan details
Getting started

Your first sale this week. Setup in 5 minutes.

Our onboarding team runs the process. Data migration, product mapping, and channel connection included — first sale on average in 3–7 days.

LET'SGO