SDKs

Typed libraries for calling the revenexx API and for building on the platform — API clients for several languages, the CLI, the App SDK, and the Integration Node SDK.

API clients

Web / JavaScript

Typed client for the revenexx API. Runs in the browser, Node, and edge runtimes.

Node

Server-side typed client for the revenexx API, for Node back ends and jobs.

PHP

Typed client for the revenexx API from PHP servers and apps.

CLI

Drive the platform from your terminal and scripts.

Build on the platform

App SDK

Build revenexx Apps — a typed data client and an HTTP router for your app's function.

Integration Node SDK

Build custom nodes for Integration Studio workflows.

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.

LanguagePackageStatus
Web / JavaScript@revenexx/sdkShipped
Node@revenexx/nodeShipped
PHPrevenexx/sdkFirst version
CLI@revenexx/cliFirst version

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 the customer console.
  • 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

More client languages are in development. Until one ships, call the API directly, or use the Web / JavaScript SDK (it runs in Node and edge runtimes).

TargetPackageStatus
Web / JavaScript@revenexx/sdkShipped
Node@revenexx/nodeShipped
PHPrevenexx/sdkFirst version
Apple (Swift)—In development
Android (Kotlin)—In development
Flutter (Dart)—In development
Python—In development
Go—In development
Rust—In development

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.

SDKPackageWhat 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-sdkCustom 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