Accéder au SDK Javascript sur votre site web
Lorsqu'il est chargé sur votre site web, Axeptio expose une instance JS de notre classe SDK, qui contient des méthodes et des informations utiles. Avec cet objet, vous pouvez personnaliser les propriétés à l'exécution ou afficher n'importe quel widget configuré dans votre projet.
Utiliser une fonction de rappel (callback) pour obtenir une référence au SDK
Comme le SDK est chargé de manière asynchrone, il se peut qu'il ne soit pas disponible au moment où vous exécutez votre propre code. Pour être averti lorsque l'objet axeptioSDK est prêt, vous devez utiliser une variable nommée _axcb (pour Axeptio Callbacks). Voici un extrait de code :
window._axcb = window._axcb || [];
window._axcb.push(function(sdk){
// ici, vous pourrez accéder aux méthodes et propriétés
// de l'instance SDK d'Axeptio.
});
Sur la première ligne, nous accédons au tableau _axcb s'il existe déjà, ou nous le créons. C'est une technique abrégée pour "accéder ou créer" une variable en JavaScript.
Ensuite, nous ajoutons une fonction de rappel à ce tableau en utilisant la méthode push(). Le contenu de cette fonction sera exécuté uniquement une fois que le script Axeptio sera chargé et que la configuration du projet aura été récupérée depuis notre CDN. Pas d'inquiétude si Axeptio est déjà chargé, votre fonction de rappel sera alors appelée immédiatement.
Alternative : utiliser l'objet window.axeptioSDK
Lorsque Axeptio est prêt, il crée plusieurs méthodes et objets directement dans le scope global window.
- axeptioSDK : instance de l'objet SDK.
- axeptioBuildTimestamp : date et heure de la construction du script SDK. Utilisé pour résoudre les problèmes de cache.
- openAxeptioCookies(settings) : appelez cette fonction pour ouvrir le widget de cookies. Vous pouvez passer un objet avec des paramètres supplémentaires, comme
currentStepIndex,onComplete,onEvent,userChoices. Si vous avez besoin d'aide pour utiliser ces paramètres, contactez-nous. - showAxeptioButton() : cette fonction affiche le bouton Axeptio dans le coin de la page, s'il est masqué.
- hideAxeptioButton() : cette fonction masque le bouton Axeptio dans le coin de la page, s'il est visible.
Étant donné que le SDK Axeptio peut ne pas être chargé au moment où vous exécutez votre propre code, nous recommandons d'utiliser la méthode avec fonction de rappel.
Anatomie du SDK Axeptio
Méthodes
sdk.openCookies(settings)
Alias de openAxeptioCookies, cette méthode ouvre le widget de consentement pour la cookiesVersion actuelle.
sdk.createConsentCheckbox()
Crée une case à cocher pour un widget de traitement de données correspondant.
sdk.createConsentButton()
Crée un bouton de consentement pour un widget de traitement de données correspondant.
sdk.setCookiesVersion(version)
Spécifie la version des cookies à utiliser. Cette méthode peut être utilisée à l'exécution pour changer de langue, par exemple.
sdk.setToken(token)
Spécifie le token utilisateur à utiliser pour les collectes de consentement ultérieures.
sdk.hasAcceptedVendor(vendor)
Renvoie un booléen indiquant si l'utilisateur a accepté l'utilisation d'un service spécifique.
Remarque : le service est un identifiant sous forme de chaîne de caractères que vous pouvez définir dans l’administration Axeptio.
sdk.requestConsent(vendor, onConsent)
Demande le consentement pour un service spécifique. Renvoie une promesse qui se résout lorsque le consentement est accordé et est rejetée lorsqu'il ne l'est pas.
Propriétés
sdk.settings
Un objet contenant les paramètres du SDK (liés au site web).
sdk.userPreferencesManager
Un objet contenant les préférences et des méthodes utilitaires pour gérer les préférences des utilisateurs.
sdk.config
La configuration complète générée par notre API lors de la publication du projet.
sdk.template
Le projet de modèle utilisé si Axeptio est intégré à un service spécifique (Typeform, etc.).