Francais
Nos formules
Intégration Site
Intégration technique
Consentements Marketing
Paramètres avancés
RESTful API
SDK Javascript d'Axeptio
Accédez au SDK Javascript sur votre site
Quand il est chargé sur votre site, Axeptio va monter une instance JS de notre classe SDK, qui contient des méthodes et des informations utiles. Avec cet objet, vous pouvez modifier des propriétés à la volée ou afficher n'importe quel widget de votre configuration.
Utiliser une fonction callback pour faire référence au SDK
Le SDK étant chargé de façon asynchrone, il peut ne pas être présent à l'exécution de votre code. Pour être averti quand l'objet axeptioSDK est prêt, vous pouvez utiliser une variable nommée
_axcb (signifiant Axeptio Callbacks). Voici le bout de code :1
window._axcb = window._axcb || [];
2
window._axcb.push(function(sdk){
3
// Vous pourrez accéder ici aux méthodes et propriétés
4
// de l'instance du SDK Axeptio.
5
});
Copied!
Sur la première ligne, nous accédons au tableau
_axcb s'il existe déjà, ou nous le créons. C'est un raccourci pour accéder ou créer une variable en JS.Puis nous ajoutons une fonctioon callback dans le tableau avec la méthode
push() . L'intérieur de cette fonction sera éxecutée uniquement après le chargement du script Axeptio et la récupération de la configuration du projet depuis notre CDN. Si Axeptio est déjà chargé, pas d'inquiétudes, le callback sera appelé immédiatement.Alternative: utiliser l'objet window.axeptioSDK
window.axeptioSDK Quand Axeptio est prêt, il crée quelques méthodes et objets directement au niveau de l'objet
window- axeptioSDK instance de l'objet SDK
- axeptioBuildTimestamp date et heure de montage du script SDK. Utilisé pour gérer les problèmes de cache.
- openAxeptioCookies(settings) Appelez cette fonction pour ouvrir le widget de cookies. Vous pouvez passer un objet avec des propriétés additionnelles, comme
currentStepIndex,onComplete,onEvent,userChoices. Si vous avez besoin d'utiliser ces propriétés et avez besoin de notre aide, contactez nous. - showAxeptioButton() cette fonction fait apparaitre le bouton Axeptio au coin de la page, s'il est caché.
- hideAxeptioButton() cette fonction cache le bouton Axeptio, s'il est visible.
Vu que le SDK Axeptio pourrait ne pas être chargé quand vous éxecutez votre code, nous recommandons l'utilisation de la méthode callback.
Anatomie du SDK Axeptio.
Méthodes
sdk.openCookies(settings)
Alias de openAxeptioCookies(), cette méthode ouvre le widget de consentement cookies avec la cookiesVersion actuelle.
sdk.createConsentCheckbox()
Crée une case à cocher pour un widget de consentement marketing ou contractuel donné.
sdk.createConsentButton()
Crée un bouton pour un widget de consentement marketing ou contractuel donné.
sdk.setCookiesVersion(version)
Spécifie la version de widget cookie à utiliser. Cette méthode peut être utilisée à la volée pour changer de version en fonction des locales, par exemple.
sdk.setToken(token)
Spécifie le token utilisateur qui sera utilisé pour les futures collectes de consentement.
sdk.hasAcceptedVendor(vendor)
Renvoie un booléen indiquant si l'utilisateur a accepté ou non un vendeur spécifique. Note : le vendeur est une chaine de charactères que vous pouvez modifier dans le backoffice Axeptio.
sdk.requestConsent(vendor, onConsent)
Demande le consentement pour un vendeur spécifique. Renvoie une promesse résolue quand le consentement est accordé, et rejeté quand il ne l'est pas.
Propriétés
sdk.settings
Un objet contenant les paramètres pour le SDK (lié au site).
sdk.userPreferencesManager
Un objet contenant les préférences et méthodes utiles pour gérer les préférences utilisateur.
sdk.config
La configuration complète générée par notre API à la publication du projet.
sdk.template
Le modèle de projet utilisé si Axeptio est utilisé sur un service spécifique (Typeform, etc.)
Last modified 1yr ago