Toegang tot de JavaScript SDK op uw website
Wanneer het op uw website wordt geladen, stelt Axeptio een JS-exemplaar van onze SDK-klasse beschikbaar, die nuttige methoden en informatie bevat. Met dit object kunt u eigenschappen tijdens runtime aanpassen of widgets weergeven die in uw project zijn geconfigureerd.
Een callback-functie gebruiken om een verwijzing naar de SDK te krijgen
Omdat de SDK asynchroon wordt geladen, is deze mogelijk niet beschikbaar op het moment dat u uw eigen code uitvoert. Om op de hoogte te worden gesteld wanneer het object axeptioSDK gereed is, moet u een variabele gebruiken die _axcb heet (voor Axeptio Callbacks). Hier is een codefragment:
window._axcb = window._axcb || [];window._axcb.push(function(sdk){ // hier kunt u toegang krijgen tot de methoden en eigenschappen // van de Axeptio SDK-instantie.});Op de eerste regel krijgen we toegang tot de array _axcb als deze al bestaat, anders maken we deze aan. Dit is een verkorte techniek voor "toegang krijgen tot of aanmaken van" een variabele in JavaScript.
Vervolgens voegen we een callback-functie aan deze array toe met behulp van de methode push(). De inhoud van deze functie wordt alleen uitgevoerd zodra het Axeptio-script is geladen en de projectconfiguratie is opgehaald van onze CDN. Geen zorgen als Axeptio al is geladen, uw callback-functie wordt dan onmiddellijk aangeroepen.
Alternatief: het object window.axeptioSDK gebruiken
Wanneer Axeptio gereed is, maakt het verschillende methoden en objecten direct beschikbaar in het globale bereik window.
axeptioSDK: exemplaar van het SDK-object.
axeptioBuildTimestamp: datum en tijd van de constructie van het SDK-script. Wordt gebruikt voor het oplossen van cacheproblemen.
openAxeptioCookies(settings): roep deze functie aan om de cookie-widget te openen. U kunt een object met aanvullende parameters doorgeven, zoals
currentStepIndex,onComplete,onEvent,userChoices. Neem contact met ons op als u hulp nodig hebt bij het gebruik van deze parameters.showAxeptioButton(): deze functie geeft de Axeptio-knop in de hoek van de pagina weer, als deze verborgen is.
hideAxeptioButton(): deze functie verbergt de Axeptio-knop in de hoek van de pagina, als deze zichtbaar is.
Omdat de Axeptio SDK mogelijk niet is geladen op het moment dat u uw eigen code uitvoert, raden wij aan om de methode met callback-functie te gebruiken.
Anatomie van de Axeptio SDK
Methoden
sdk.openCookies(settings)
Alias van openAxeptioCookies, deze methode opent de toestemmingswidget voor de huidige cookiesVersion.
sdk.createConsentCheckbox()
Maakt een selectievakje voor een overeenkomstige gegevensverwerkingswidget.
sdk.createConsentButton()
Maakt een toestemmingsknop voor een overeenkomstige gegevensverwerkingswidget.
sdk.setCookiesVersion(version)
Geeft de versie van de cookies aan die moet worden gebruikt. Deze methode kan tijdens runtime worden gebruikt om bijvoorbeeld van taal te wisselen.
sdk.setToken(token)
Geeft het gebruikerstoken aan dat moet worden gebruikt voor volgende toestemmingsverzamelingen.
sdk.getToken()
Retourneert het Axeptio-gebruikerstoken voor de huidige sessie.
sdk.hasAcceptedVendor(vendor)
Retourneert een boolean die aangeeft of de gebruiker het gebruik van een specifieke service heeft geaccepteerd.
Opmerking: de service is een string-identifier die u in het Axeptio-beheerderdeelkunt instellen.
sdk.requestConsent(vendor, onConsent)
Vraagt toestemming voor een specifieke service. Retourneert een belofte die wordt opgelost wanneer toestemming wordt gegeven en wordt geweigerd wanneer dit niet het geval is.
Eigenschappen
sdk.settings
Een object met de SDK-instellingen (gerelateerd aan de website).
sdk.userPreferencesManager
Een object met voorkeuren en hulpmiddelen voor het beheren van gebruikersvoorkeuren.
sdk.config
De volledige configuratie gegenereerd door onze API bij publicatie van het project.
sdk.template
Het sjabloonproject dat wordt gebruikt als Axeptio is geïntegreerd met een specifieke service (Typeform, enzovoort).