SDKs
API
Getting started
Load the SDK
Script
We offer the Didomi SDK as a hosted JavaScript library that you can directly include on your website with a
<script> tag.Create a Consent Notice in the Didomi Console and get the script tag from the Embed section. Paste the tag the top of the
<head> section of your HTML pages, before any other script tag.Important: We recommend that you integrate the tags in the following order:
- 1.Conditioned vendors tags (header)
- 2.Didomi SDK (header)
- 3.Non-conditioned vendors tags
Make sure to add the tag as close to the opening
<head> tag on your page as possible, before any other tag gets embeddedKeep in mind that the role of our JavaScript SDK is to share consent information with all the other scripts on the page. In order to do so, it MUST be placed before any other tag or the tags from your vendors will not be able to collect consent information from us. Put it as close as possible to the opening
<head> tag. If our SDK gets included after the other tags then the consent information will not be correctly shared and you will not be compliant with the GDPR requirements.If you are using Content Security Policy for whitelisting content source domains, you have to make sure that you whitelist https://sdk.privacy-center.org/ and https://api.privacy-center.org/ to allow the Didomi SDK to operate normally.
Hybrid Apps: If you are embedding our tag as part of your hybrid app (Electron, Cordova, etc), make sure to set a custom domain as part of the configuration object.
React
You can skip this section if you don't have a React application.
We also provide a React component to simplify the integration of our SDK with React applications. To use it, please follow the steps below or go directly to our React component documentation: https://github.com/didomi/react
- 1.Install the library using npm.
1
npm install --save @didomi/react
Copied!
2. Import the module in your app.
1
import { DidomiSDK } from '@didomi/react';
Copied!
We recommend instantiating the component as soon as possible: the sooner you instantiate the component, the faster the banner will be displayed or the faster the consents will be shared with your partners and the ads displayed.
3. Instantiate the component in your app
1
<DidomiSDK
2
iabVersion={2}
3
gdprAppliesGlobally={true}
4
onReady={didomi => console.log('Didomi SDK is loaded and ready', didomi)}
5
onConsentChanged={cwtToken => console.log('A consent has been given/withdrawn', cwtToken)}
6
onNoticeShown={() => console.log('Didomi Notice Shown')}
7
onNoticeHidden={() => console.log('Didomi Notice Hidden')}
8
/>
Copied!
The SDK will automatically pull the notice configuration from the Didomi Console.
Testing from outside the EU
If your banner is configured to not display to non EU visitors, it might be tricky to configure and test if you are not located in the EU yourself. You can use the
notice.ignoreCountry: true option if you are testing the banner from the US and force it to be shown to make sure it is working properly.Another option is to add
#didomi:notice.ignoreCountry=true to the URL in your browser bar to force the SDK to ignore the country on the page. Example: If your website is https://www.mywebsite.com, go to https://www.mywebsite.com/#didomi:notice.ignoreCountry=true and the notice should be displayed even if you are not in the EU.Configure and interact with the SDK
Once the SDK has loaded, you can call other functions on it to do consent management, send analytics events, etc. To make sure that you use the SDK when it is ready, you can register a global didomiOnReady array of functions that will get called when the SDK is done loading:
Plain Javascript
React
1
<script type="text/javascript">
2
window.didomiOnReady = window.didomiOnReady || [];
3
window.didomiOnReady.push(function (Didomi) {
4
// Call other functions on the SDK
5
});
6
</script>
Copied!
1
onDidomiReady(didomi) {
2
console.log('Didomi Ready');
3
// Call other functions on the SDK
4
}
5
6
...
7
8
<DidomiSDK
9
...
10
onReady={this.onDidomiReady.bind(this)}
11
/>
Copied!
The SDK exposes other events and functions to allow you to interact programmatically with the CMP. Read our Reference section for more information:
Configure vendors and purposes
As per GDPR, the consent notice collects consents for a specific set of vendors and purposes. You must configure the notice to let it know what vendors are used on your website and it will automatically determine what purposes are required. This can be done from the Didomi Console.
While we interoperate with a lot of vendors through the IAB framework or direct integrations, vendors that do not fall into either of these buckets must be configured through our tag manager or your existing tag manager. Failure to do so will result in vendors not being correctly blocked as needed and you will not be compliant with data privacy regulations.
Add a link for the user to manage their preferences
After the user has given consent or closed the banner, you must given them an easy access to their choices so that they can update them.
You can use the function
Didomi.preferences.show() to open the preferences manager and let the user update her choices. Example:Plain Javascript
React
1
<a href="javascript:Didomi.preferences.show()">Consent preferences</a>
Copied!
1
onDidomiReady(didomi) {
2
this.didomiObject = didomi;
3
}
4
5
...
6
7
<DidomiSDK
8
...
9
onReady={this.onDidomiReady.bind(this)}
10
/>
11
<button onClick={() => this.didomiObject.preferences.show()}>Consent preferences</button>
Copied!
We suggest adding this link in your privacy policy or in a header or footer menu on all of your pages.
IAB frameworks
Didomi supports the IAB Transparency and Consent Framework as well as the IAB CCPA frameworks. Read more in our documentation:
Last modified 3mo ago