Guides

Pick the outcome you want. Each path below names what you are building, what you need before you start, the first command to run, and the guides to follow in order. All four run against the same tenant, and everything you deploy ships with the revenexx CLI.

Build an App

You are building a directory of JSON contracts plus one Node function. The platform provisions the tables, publishes your routes as API capabilities behind api.revenexx.com, and installs the result on a tenant.

Before you start

• A revenexx account and a tenant you may install apps on. See Prerequisites.
• Node.js 22 or newer.
• The revenexx CLI, signed in with revenexx login.

First command

revenexx create app locations --entity locations

Then follow

1. Your first App in 15 minutes — scaffold, deploy, and call it live.
2. Build your first App — the same app, built file by file so you understand each contract.
3. Add a data model — entities, relationships, and custom routes.
4. Deploy with the CLI — ship and verify against the gateway.

Reference: App Studio and the App SDK.

Build a storefront

You are building a Theme: a Nuxt 4 server-rendered site that renders a tenant's Storefront and lets editors compose pages from Blökkli blocks. A Theme is published and installed like an app, and one deployed Theme serves many tenants.

Before you start

• Node.js 22 or newer.
• The revenexx CLI, signed in.
• A tenant slug. You need it once the Theme reads real data, not before.

First command

revenexx create theme my-storefront

Then follow

1. Experience Studio: getting started — a working shop on your machine, then live on a preview URL.
2. Build your first Theme — the manifest, a local run, and a first deployment.
3. Customize blocks — build Blökkli blocks and connect them to live data.
4. Theme tokens & styling — white-label with design tokens.
5. Deploy your storefront — git-connected and CLI deploys, previews, rollbacks.

Reference: Experience Studio and the Web SDK.

Connect a system

You are building a workflow in Integration Studio: a trigger, a graph of nodes, and the credentials it runs with. It moves data between the platform and an external system without middleware of your own. Everything happens in Cockpit. There is nothing to install and no local project.

Integration Studio is experimental and its schemas are drafts. The pages linked here are current, not final.

Before you start

• A tenant with Integration Studio enabled and permission to open it.
• Credentials for the system you connect, once you go beyond the first test workflow.

First step

In Cockpit, open Integration Studio → Workflows → New.

Then follow

1. Integration Studio: getting started — build a first workflow, run it by hand, put it on a schedule.
2. Import a BMECAT catalog — pull a supplier's catalog, map its articles, and upsert them over the gateway.

Reference: Integration Studio.

Call the API directly

You are building your own client against the gateway: one base URL, versioned under /v1, JSON in and out. Use this path when your code runs outside the platform and needs to read or write tenant data.

Before you start

• A tenant slug.
• An API key (rvxk_…), created in Cockpit. See API keys. For calls on behalf of a signed-in user, send their token instead.

First command

curl https://api.revenexx.com/v1/products \
  -H "X-Revenexx-Tenant: <TENANT_SLUG>" \
  -H "X-Revenexx-Api-Key: rvxk_..."

Then follow

1. API usage — headers, request IDs, errors, pagination, and what /v1 guarantees.
2. Authentication — API keys for servers, user tokens for people.
3. SDKs — typed clients that make the same calls.
4. API Explorer — browse and try every endpoint.

Configure commerce

Set up the business rules that drive selling.

• Configure pricing rules — customer-specific pricing, market overrides, and approval steps.

In a hurry?

Clone a working example: a reference App or a reference storefront Theme you can deploy to your own tenant in a few commands, then read the guides above to see how it is built.