v1 · updated 2026-09-04
Developer documentation
11 pages covering 19 public endpoints, OAuth and API keys, signed webhooks, rate limits, error handling, and how to author themes and apps. Every sample here is runnable.
Getting started
REST API
- REST API referenceEvery endpoint, the scope it needs, its cursor pagination contract and a runnable curl and TypeScript sample.
- ErrorsProblem responses, the stable error codes, which ones are safe to retry and how to log them without leaking data.
- Rate limitsThe buckets, the headers on every response, what happens on a limiter outage, and how to stay well under the ceiling.
- WebhooksSubscribe to events, verify the HMAC signature in constant time, survive retries and make your handler idempotent.
- Themes APIList installed themes, read their assets, browse the marketplace and switch the live storefront theme from code.
Extending Framique
- TypeScript SDKA thin typed client over the same REST surface: retries, pagination helpers and webhook verification in one import.
- Theme authoringBuild a storefront theme from tokens, sections and templates, then export it as a versioned, installable bundle.
- Apps and app blocksShip an app that adds blocks to the page builder, requests scopes honestly and runs sandboxed on the storefront.
Running in production
Versions
Breaking changes get a new version and 90 days' notice. Retired versions keep answering until their sunset date, and say so in a response header long before that.
Building for other merchants? See pricing for plan limits that affect API quota, or contact the team about partner terms. The full feature map lives on features.