Documentation Index

Fetch the complete documentation index at: https://usercentrics.document360.io/llms.txt

Use this file to discover all available pages before exploring further.

Configure your environment

Prev Next

Steps to integrate Usercentrics SDK, including consent handling and configuration setup.

The diagram highlights your current step in the Basic App CMP setup flow.
Here, you’ll use the Admin Interface to configure your app and generate the settings needed for the SDK integration.

Sign up or log in

You need an account to configure your consent banner.
Go to Usercentrics Admin Interface to create a Usercentrics account or start a free trial for Usercentrics App CMP.

Create or use an existing configuration

In the Admin Interface, go to Configurations and click Add Configuration to create a new one.
If a configuration already exists for your app, you can simply reuse it instead of creating a new one.

Select the relevant legal framework.

Add  a name for the new configuration.
Adding the name of the Data Controller entity at your company is optional.

Choose between SettingsID or RulesetID

Depending on your setup, you may choose one of the following options:

  • Initialize Usercentrics with a RulesetID, if you are using geolocation rules, and wish to target users based on their location.

  • Initialize Usercentrics with a SettingsID, if you want to have one specific configuration, regardless of user location.

Both values should not be used at the same time

Where to find your RulesetID or SettingsID?

SettingsID

To find the SettingsID, open the configuration you want to use and navigate to Configuration. The SettingsID is in the header breadcrumbs:

RulesetID

To find the RulesetID, navigate to Geolocation Rulesets and select the Implementation tab on the ruleset you want to use. The RulesetID is in RulesetID section: