API Onsite
Commencer
L'API onsite est utilisée pour interagir avec les fonctionnalités de Commanders Act via JavaScript.
Comment utiliser
L'API onsite consiste en une seule fonction, cact(), avec la signature stricte suivante :
cact(command, [options,] [callback])command
Un identifiant chaîne utilisé pour sélectionner la méthode souhaitée.
Requis
options
Un objet JavaScript qui inclut les données transmises à la méthode.
Optionnel
callback
Une fonction de rappel JavaScript utilisée pour recevoir des informations ou des événements de l'API onsite.
Optionnel
L'API onsite est incluse dans chaque containers et privacy banners.
Envoyer un événement
Pour envoyer des données d'événement vers la plateforme Commanders Act côté serveur, utilisez cette commande :
cact('<event_name>', {<event_params>});Exemple : pour envoyer un événement d'achat :
cact('purchase', {
id:'1234',
currency: 'EUR',
//...
});Obtenir des informations
Pour obtenir diverses valeurs depuis Commanders Act, utilisez cette commande :
cact(get command, [callback])Exemple : pour obtenir le consentement depuis TrustCommander, vous pouvez appeler la consent.get API comme ceci :
cact('consent.get', function(result) {
if (result.consent.status === "all-on") {
// Consentement disponible pour toutes les catégories.
}
});Les méthodes de l'API onsite sont appelées de manière asynchrone. Si, par exemple, vous avez besoin d'informations de manière synchrone dans le <head> du document, il est recommandé de mettre en cache et de récupérer le résultat de l'API dans localStorage.
Gestion des erreurs
Vous pouvez gérer les erreurs via la propriété error dans l'objet de callback. Exemple :
cact('consent.get', function(result) {
if (result.error) {
// Gérer l'erreur
}
else if (result.consent.status === "all-on") {
// Consentement disponible pour toutes les catégories.
}
});API Stub (optionnel)
Pour un usage avancé, nous fournissons également un stub d'API qui peut être ajouté lorsque vous avez besoin d'interagir avec l'API avant que les containers ou les bannières ne soient chargés. Ce stub est déjà inclus dans les containers et les bannières de confidentialité, vous n'avez donc pas à l'ajouter dans la plupart des cas d'utilisation. Le stub est utilisé pour mettre en tampon toutes les méthodes dans un tableau JavaScript jusqu'à ce que le JavaScript de Commanders Act soit chargé et prêt à traiter les méthodes. Cela permet par exemple d'utiliser l'API onsite avant que le JavaScript de TrustCommander soit chargé.
window.caReady = window.caReady || [];
window.cact = function() { window.caReady.push(arguments); };window.caReady est un tableau JavaScript qui met en mémoire tampon les interactions avec l'API. window.cact est une fonction JavaScript utilisée pour interagir avec l'API onsite.
Si vous travaillez dans une grande équipe et n'êtes pas sûr que le stub ait déjà été installé, il est acceptable d'installer le stub JavaScript plusieurs fois.
Mis à jour
Ce contenu vous a-t-il été utile ?