SDKs
API clients
Build on the platform
The SDKs fall into two groups. API clients call the revenexx API for you, so you don't hand-write HTTP requests, headers, and response parsing. Platform SDKs let you build on revenexx itself: ship Apps, or add your own nodes to Integration Studio.
API clients
A typed wrapper over the revenexx API at api.revenexx.com. You set the endpoint, your tenant, and a credential once, then call methods on a service instead of building requests.
| Language | Package | Status |
|---|---|---|
| Web / JavaScript | @revenexx/sdk | Shipped (0.x) |
| Node | @revenexx/node | Shipped (0.x) |
| PHP | revenexx/sdk | Shipped (0.x) |
| CLI | @revenexx/cli | Shipped (0.x) |
Shipped means the package is in its registry and installs today. The 0.x marks the API surface, not the availability: these clients are in use, but method names and shapes can still change between minor versions before 1.0. Pin a version you've tested and read the release notes before you upgrade. For the exact current version, ask the registry rather than this page — npm view @revenexx/sdk version, or the package page on Packagist. Versioning & stability sets out what the number promises now and what changes at 1.0.
All clients share the same auth contract:
Authorization: Bearer <token>— a token from ID or a personal access token.X-Revenexx-Api-Key— a machine-to-machine key, created in Cockpit.X-Revenexx-Tenant: <slug>— which tenant the request applies to.
Every client points at the single gateway, https://api.revenexx.com, and selects the tenant with its slug. There's no per-region host to configure.
Other languages
Twelve more targets are in development. Each is generated from the same OpenAPI document as the shipped clients, but none has a tagged release yet, so there is nothing to install and no page to read for them — a target's page goes live the day it ships.
| Target | Runs on |
|---|---|
| Apple (Swift) | iOS, macOS, watchOS, tvOS |
| Android (Kotlin) | Android |
| Flutter (Dart) | Mobile, desktop, and web from one codebase |
| React Native | React Native and Expo apps |
| Swift | Server-side Swift — back ends, CLI tools, jobs |
| Kotlin | The JVM — back ends, batch jobs, scheduled work |
| Dart | Server-side Dart — services and CLI tools |
| .NET | C# back ends, worker services, desktop apps |
| Ruby | Ruby servers and scripts |
| Python | Python services and scripts |
| Go | Go services |
| Rust | Rust services |
The mobile and desktop targets are separate packages from their server-side counterparts, because a client running on an end user's device authenticates per user, while a server client uses a machine-to-machine key. That is why Apple and Swift, Android and Kotlin, Flutter and Dart are each two targets rather than one.
Until a target ships, you have three options that work today: call the API directly, use the Web / JavaScript SDK (it runs in Node and edge runtimes), or drive the platform from the CLI. You can also browse and call every endpoint without an SDK in the API Explorer.
Build on the platform
Two SDKs are for extending revenexx rather than calling it.
| SDK | Package | What you build |
|---|---|---|
| App SDK | @revenexx/app-sdk (also revenexx/app-sdk for PHP) | revenexx Apps — installable units of commerce logic. |
| Integration Node SDK | @revenexx/integrations-node-sdk | Custom nodes for Integration Studio workflows. |
The App SDK gives your app a typed data client over its own tables and a small HTTP router for the app's function handler. The Integration Node SDK gives you the types and CLI to build a node that drops into the Integration Studio workflow engine.
How the SDKs are made
The API clients are generated from the per-tenant OpenAPI document the gateway publishes at /v1/openapi.json. That keeps every client in step with the API, and it's how new languages get added over time. As a partner you install the published package; you don't run the generator.
Where to go next
- Web / JavaScript SDK — install and make your first call.
- Node SDK — the same client, for server-side JavaScript.
- PHP SDK — the same, from PHP.
- CLI — manage the platform from your terminal.
- App SDK — build a revenexx App.
- Integration Node SDK — build an Integration Studio node.
- Versioning & stability — what a package version promises, and how to pin and upgrade.
- API Explorer — try every endpoint in the browser.