The Omneo SDK is the typed JavaScript and TypeScript client for the Omneo API. It works in Node and modern browsers, and is the recommended way to call Omneo from JavaScript instead of constructing raw HTTP requests.Documentation Index
Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
Use this file to discover all available pages before exploring further.
What the SDK provides
| Capability | What it does |
|---|---|
| Typed surface | TypeScript types for every resource, request, and response. |
| Auth header injection | Adds the bearer token to every request, removes the need to build headers by hand. |
| Resource namespaces | Around 59 admin namespaces (Profiles, Transactions, Orders, Rewards, Benefits, Tiers, Points, Lists, Targets, Webhooks, and more), plus profile-scoped sub-resources for the customer-facing client. |
| Profile-scoped helpers | One-call helpers like profiles.findByIdentity, profiles.merge, profiles.checkAvailability. |
| Token lifecycle | Helpers for minting, checking expiry, and resetting profile-scoped IDTokens. |
| Escape hatch | A call() method on both clients for new endpoints the SDK does not yet wrap natively. |
Two-client model
The SDK exports two classes from a single package,@omneo/omneo-sdk:
| Client | Targets | Token | Audience |
|---|---|---|---|
Omneo | https://api.[tenant].getomneo.com/api/v3 | Long-lived admin bearer token | Trusted backend code |
ID | https://api.[tenant].getomneo.com/id/api/v1 | Short-lived profile-scoped JWT | Storefronts and any customer-facing browser code |
Omneo client speaks the admin API and carries broad scopes. It must stay on a server.
The ID client speaks the profile-scoped ID API. It is initialised once on a trusted server with an admin token to mint an IDToken. The IDToken is bound to a single profile and is safe to use from a browser to read and update only that profile.
Where the SDK fits
The SDK sits between application code and the Omneo HTTP API. Server code usesOmneo to manage profiles, transactions, incentives, and configuration. Customer-facing code uses ID to render and update a single profile through the same authenticated session.
The two clients pair with the wider profile portal and Omneo wallet surfaces. They share the same data model, so a backend job that updates a profile through Omneo is immediately visible to a storefront calling ID.