Feeef Developer Platform
The map of everything you can build on Feeef — API, OAuth apps, SDKs, CLI, templates and webhooks.
Feeef is a commerce platform for merchants — stores, products, COD orders, delivery integrations, finance and inventory. The developer platform exposes all of it so you can build integrations, storefront themes and full applications on top.
This page is the map. Every area links to a detailed guide.
The platform at a glance
Quickstart
Get a token, make your first API call, register your first app — in ten minutes.
Apps & OAuth 2.0
Register OAuth clients, run the authorization-code flow with PKCE, request scopes.
JavaScript SDK
The feeef npm package — typed repositories over the whole API, plus cart and realtime.
Dart SDK
The feeef Dart package that powers the official merchant app.
Feeef CLI
@feeef.dev/cli — sign in, scaffold themes, preview drafts and publish to the marketplace.
Storefront templates
The Lithium template engine: TemplateData, custom components, theme packages.
Webhooks
HMAC-signed order and product events pushed to your endpoints, with delivery history.
REST API conventions
Hosts, pagination, the filterator query language, batch operations and errors.
MCP server
138 tools over Streamable HTTP — stores, orders, inventory, finance, creative.
Hosts
| Host | Role |
|---|---|
https://api.feeef.org/v1 | Machine-facing JSON API: resources, POST /oauth/token, revoke, introspect. Also mounted as /api/v1 on other hosts. |
https://accounts.feeef.org | Human-facing sign-in and the OAuth consent screen (GET /oauth/authorize). |
https://feeef.dev | This portal — documentation plus the developer dashboard for managing apps. |
https://{slug}.feeef.store | Hosted storefronts rendered by the Lithium template engine. |
https://api.feeef.org/openapi | Interactive OpenAPI reference generated from the backend. |
https://mcp.feeef.org/mcp | Streamable-HTTP MCP server — 138 tools for AI agents (OAuth or bearer). |
How the pieces fit together
| Surface | What it is | Where to start |
|---|---|---|
| REST API | AdonisJS backend, opaque bearer tokens, {data, meta} pagination, filterator queries, batch endpoints, SSE realtime. | API conventions |
| Apps (OAuth clients) | Registered clients with clientId/clientSecret, exact-match redirect URIs, scope allowlists, public/confidential types and JSON data buckets. Managed in the dashboard or via /apps. | Apps & OAuth |
| OAuth 2.0 provider | Authorization-code flow (RFC 6749) with PKCE (RFC 7636), consent on the accounts host, revocation (RFC 7009) and introspection (RFC 7662). Tokens carry the consented scopes as abilities. | Authorization code flow |
| Scopes | Store member RBAC strings (orders, products.read, store.integrations, …) plus platform scopes (auth, apps). One vocabulary for team roles and API tokens. | Scopes |
| JavaScript SDK | npm install feeef — FeeeF client with 25+ repositories (stores, products, orders, users, apps, oauth, inventory, finance, …), a client-side cart service, storage uploads and Transmit realtime. | JS SDK |
| Dart SDK | Feeef.instance singleton with the same repository surface, freezed models, offline-tolerant auth and 11 delivery-carrier integrations. Powers the merchant app. | Dart SDK |
| CLI | npm i -g @feeef.dev/cli → feeef binary. Browser OAuth sign-in (PKCE), theme scaffolding, remote draft preview and marketplace publishing. | CLI |
| MCP server | Streamable-HTTP MCP at mcp.feeef.org — 138 tools across stores, orders, inventory, finance, creative. OAuth PKCE or bearer. | MCP |
| Templates | A storefront theme is a JSON document (TemplateData) rendered by the Lithium engine, authored as a Node package of flat TSX components and compiled by the template kit. | Templates |
| Webhooks | Per-store order and product events (orderCreated, productUpdated, …), HMAC-SHA256 signed, with persisted delivery history and test tooling. | Webhooks |
| App data buckets | Namespaced JSON on every app (public/private) and per (app, user) pair (public/private/protected) — configuration and user state without running your own database. | App data |
Typical integration shapes
- "Sign in with Feeef" — register an app with the default
authscope and run the authorization-code flow to identify users. No further permissions needed. - Store automation — request
orders/products/store.integrationsscopes and use the JS or Dart SDK with the user's token to manage a store on their behalf; subscribe to webhooks for order and product events. - Storefront theme — scaffold with
feeef template init, build with the template kit, preview drafts on a live store and publish (free or paid) to the marketplace. - Companion app with its own state — store per-user JSON in
app data buckets using a token bound to your app with the
appsscope.