To start integrating the SDK, you'll need an active developer account.
As of now, developer accounts are invite-only based on an existing B2B contract. Please get in touch (opens in a new tab) if you'd like to evaluate the SDK.
The SDK can only be used with an active license. The license is fetched automatically whenever the SDK is initialized - internet connection is required for the first SDK usage on any device.
On mobile devices the license is locally persisted and valid for 3 days without requiring connectivity with the licensing server.
In order to initialize the SDK on any platform, you'll need an API key. The API key consists of 32 hex characters (such as
aaaa00baba11abba1081081234567890) and is connected with a particular license.
You can access your API keys in the Customer Dashboard (opens in a new tab).
Depending on your contract, SDK usage will be counted in one of three modes:
- Per-user (automatic)
- Per-user (manual)
For the initial POC contract you don't need to worry about the usage, but you'll still be able to monitor it in the dashboard.
In this mode, one SDK usage is counted every time the SDK is initialized, regardless of the amount of distinct users.
In this mode, the SDK automatically generates an unique identifier at the first initialization on a given device/browser. This identifier is then persisted locally and any further SDK sessions are attributed to the same user.
The final usage will be counted based on the amount of unique monthly active users.
In case of a per-user (manual) contract you'll need to explicitly pass a user identifier to properly attribute license usages. This way, if you already have a way of identifying your users, you can attribute SDK usage across different platforms and devices to a single user.
Do not pass personally identifiable data as the user identifier.
Please see the detailed instructions in per-platform guides to see how to pass the API key and User ID during SDK initialization.