API onsite
Prise en main
L'API onsite est utilisée pour interagir avec les fonctionnalités de Commanders Act en JavaScript.
Comment l'utiliser
L'API onsite se compose d'une seule fonction, cact(), avec la signature stricte suivante :
cact(command, [options,] [callback])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 transmises à la méthode.
Facultatif
callback
Une fonction de rappel JavaScript utilisée pour recevoir des informations ou des événements de l'API onsite.
Facultatif
L'API onsite est incluse dans chaque conteneur et bannière de confidentialité.
Envoyer un événement
Pour envoyer des données d'événement à la plateforme Commanders Act server-side, 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 différentes valeurs depuis Commanders Act, utilisez cette commande :
Exemple : pour obtenir le consentement de TrustCommander, vous pouvez appeler l' consent.get API comme ceci :
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 rappel. Exemple :
Stub API (facultatif)
Pour une utilisation avancée, nous fournissons également un stub API qui peut être ajouté lorsque vous avez besoin d'interagir avec l'API avant que les containers ou les bannières aient été chargés. Ce stub est déjà inclus dans les containers et les bannières de confidentialité, vous n'avez donc pas besoin de 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 Commanders Act soit chargé et prêt à traiter les méthodes. Cela permet par exemple d'utiliser l'onsite API avant que le JavaScript TrustCommander ait été chargé.
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 ?