Onsite API
Getting Started
The onsite API is used to interact with Commanders Act features with JavaScript.
How to use
The onsite API consists of a single function, cact()
, with the following strict signature:
Onsite API is included in each containers and privacy banners.
Send event
To send event data to the serverside Commanders Act platform, use this command:
Example : to send a purchase event :
Get information
To get various values from Commanders Act, use this command:
Example : to get consent from TrustCommander, you can call the consent.get
API like this:
The onsite API methods are called asynchronously. In case e.g. you need information synchronous in the <head>
of the document it is recommended to cache and retrieve the result of the API in localStorage
.
Error handling
You can handle errors through error property in the callback object. Example:
API Stub (optional)
For advance usage, we provide also an API stub that can be added when you need to interact with the API before containers or banners have loaded. This stub is already included in containers and privacy banners, so you do not have to add in most use cases. The stub is used to buffer all methods in a JavaScript array until Commanders Act JavaScript is loaded and ready to process the methods. This allows for example to use the onsite API before TrustCommander JavaScript was loaded.
window.caReady
is a JavaScript array that buffers the interactions with the API. window.cact
is a JavaScript function used to interact with the onsite API.
In case you work in a big team and are unsure the stub was already installed it is ok to install the JavaScript stub multiple times.
Last updated