search
Platform XDocumentationWelcome to Success
githubModifier

API Onsite

hashtag
Prise en main

L'API onsite est utilisée pour interagir avec les fonctionnalités de Commanders Act via JavaScript.

hashtag
Comment utiliser

L'API onsite consiste en une seule fonction, cact(), avec la signature stricte suivante :

cact(command, [options,] [callback])
Argument
Descriptions
Obligatoire

command

Un identifiant sous forme de chaîne utilisé pour sélectionner la méthode souhaitée.

Obligatoire

options

Un objet JavaScript qui inclut les données passées à 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 bannières de confidentialité.

hashtag
Envoyer un événement

Pour envoyer des données d'événement à la plateforme server-side de Commanders Act, utilisez cette commande :

cact('<event_name>', {<event_params>});

Exemple : pour envoyer un événement purchase :

cact('purchase', { 
  id:'1234',
  currency: 'EUR',
  //...
});

hashtag
Obtenir des informations

Pour obtenir diverses valeurs depuis Commanders Act, utilisez cette commande :

Exemple : pour obtenir le consentement depuis TrustCommander, vous pouvez appeler l'API consent.get comme ceci :

circle-exclamation

Les méthodes de l'API onsite sont appelées de façon asynchrone. Dans le cas où, par exemple, vous avez besoin d'informations de façon synchrone dans le <head> du document, il est recommandé de mettre en cache et récupérer le résultat de l'API dans localStorage.

hashtag
Gestion des erreurs

Vous pouvez gérer les erreurs via la propriété error dans l'objet de callback. Exemple :

hashtag
API Stub (optionnel)

Pour une utilisation avancée, nous fournissons également un stub API qui peut être ajouté lorsque vous devez 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 privacy banners, 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 ne soit chargé.

window.caReady est un tableau JavaScript qui met en buffer les interactions avec l'API. window.cact est une fonction JavaScript utilisée pour interagir avec l'API onsite.

circle-check

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.

PrécédentAPIsSuivantTMS & Consent banners IDs

Mis à jour

Ce contenu vous a-t-il été utile ?