Skip to main content
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.

​
What the SDK provides

​
Two-client model

The SDK exports two classes from a single package, @omneo/omneo-sdk: The 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 uses Omneo 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.