Toegang tot de Javascript SDK op uw website
Wanneer deze op uw website wordt geladen, stelt Axeptio een JS-instantie van onze SDK-klasse beschikbaar, die bruikbare 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 een melding te krijgen wanneer het object axeptioSDK gereed is, moet u een variabele met de naam _axcb (voor Axeptio Callbacks) gebruiken. Hier is een codefragment:
window._axcb = window._axcb || [];window._axcb.push(function(sdk){ // hier hebt u toegang tot de methoden en eigenschappen // van de Axeptio SDK-instantie.});Op de eerste regel hebben we toegang tot de array _axcb als deze al bestaat, of we maken deze aan. Dit is een verkorte techniek voor "toegang tot of creëren" 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 van onze CDN is opgehaald. Geen zorgen als Axeptio al is geladen, dan wordt uw callback onmiddellijk aangeroepen.
Alternatief: het object window.axeptioSDK gebruiken
Wanneer Axeptio gereed is, maakt het verschillende methoden en objecten rechtstreeks in het globale bereik window aan.
axeptioSDK: instantie van het SDK-object.
axeptioBuildTimestamp: datum en tijd van de constructie van het SDK-script. Gebruikt om cacheproblemen op te lossen.
openAxeptioCookies(settings): roep deze functie aan om de cookieswidget te openen. U kunt een object met aanvullende parameters doorgeven, zoals
currentStepIndex,onComplete,onEvent,userChoices. Als u hulp nodig hebt bij het gebruik van deze parameters, neem dan contact met ons op.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.
Aangezien de Axeptio SDK mogelijk niet is geladen op het moment dat u uw eigen code uitvoert, raden we aan 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 overeenkomende gegevensverwerkingswidget.
sdk.createConsentButton()
Maakt een toestemmingsknop voor een overeenkomende gegevensverwerkingswidget.
sdk.setCookiesVersion(version)
Geeft de te gebruiken cookiesversie op. Deze methode kan tijdens runtime worden gebruikt om bijvoorbeeld van taal te veranderen.
sdk.setToken(token)
Geeft het gebruikerstoken op dat moet worden gebruikt voor volgende toestemmingsverzamelingen.
sdk.getToken()
Geeft het Axeptio-gebruikerstoken voor de huidige sessie terug.
sdk.hasAcceptedVendor(vendor)
Retourneert een boolean die aangeeft of de gebruiker het gebruik van een specifieke service heeft geaccepteerd.
Opmerking: de service is een stringidentificatie die u kunt instellen in het Axeptio-beheer.
sdk.requestConsent(vendor, onConsent)
Vraagt toestemming aan voor een specifieke service. Retourneert een promise die wordt opgelost wanneer toestemming wordt verleend en wordt afgewezen 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 in een specifieke service is geïntegreerd (Typeform, enz.).