[ReactNatief] 1. consentmanager SDK-integratie
In dit document vindt u algemene informatie over hoe u onze SDK in uw project kunt integreren. Voor meer details verwijzen wij u naar onze API-referentie documentatie. Voor onze demo-app die de use cases en een implementatie laat zien die als startpunt kan dienen, kijk dan op onze repo.
1. Installatie
De consentmanager SDK voor iOS-apps implementeert en biedt functionaliteit om de gebruiker te informeren over gegevensbescherming en om toestemming van de gebruiker te vragen en te verzamelen. Het stelt app-ontwikkelaars in staat de consentmanager service in hun app.
Stappen - Beschrijving op hoog niveau
-
Integratie en configuratie:
- Integreer de SDK in uw app.
- Configureer de SDK-instellingen volgens uw behoeften.
-
Een exemplaar maken:
- Maak bij het opstarten van de app een exemplaar van het
CMPConsentTool
klas. Deze instantie zal het toestemmingsproces afhandelen.
- Maak bij het opstarten van de app een exemplaar van het
-
SDK-initialisatie:
- Zodra het exemplaar gereed is, haalt de SDK automatisch de benodigde informatie op uit de consentmanager servers ter voorbereiding op de werking ervan.
-
Het toestemmingsscherm weergeven:
- De SDK geeft indien nodig automatisch het toestemmingsscherm weer wanneer de
CMPConsentTool
exemplaar is gemaakt.
- De SDK geeft indien nodig automatisch het toestemmingsscherm weer wanneer de
-
Verwerking van persoonlijke gegevens:
- Zodra de toestemmingen zijn verzameld, wordt de informatie opgeslagen en kan deze worden opgevraagd via verschillende eigenschappen en methoden die door onze SDK worden vrijgegeven. U beschikt over informatie over geweigerde of geaccepteerde toestemmingen, leveranciers, doeleinden, enz.
Door deze stappen te volgen, zorgt u ervoor dat uw app voldoet aan de toestemmingsvereisten en dat de toestemming van gebruikers op de juiste manier wordt beheerd en opgeslagen.
Consent Manager Provider SDK-sequentiediagram
Laten we, ter illustratie van de bovenstaande stappen, in het onderstaande diagram drie mogelijke SDK-reeksstromen bekijken.
1. Bij het maken van een instantie met behulp van de initialiseren functioneren, zijn er twee mogelijke uitkomsten. De eerste is wanneer de toestemmingsmanager-API de SDK informeert dat de CMP niet kan worden geopend, waardoor de OnCmpNotOpenedCallback. Het tweede resultaat is wanneer de toestemmingslaag wordt geopend, waardoor de gebruiker ermee kan communiceren, en dit activeert de AanOpenTerugbellen. Zodra de gebruiker toestemming geeft en de toestemming is verwerkt, wordt de OnCmpCloseCallback wordt genoemd.
Houdt u er rekening mee dat de OnErrorTerugbellen wordt weergegeven door de rode onderbroken pijllijnen om voorbeelden te geven van wanneer fouten kunnen optreden tijdens het proces.
2. Een instantie maken en de openAndCheckConsent functies zullen tot een soortgelijk proces leiden. Het verschil is dat door het aanmaken van het exemplaar en de controle op de toestemmingsmanger-API te ontkoppelen, u de mogelijkheid krijgt om bedrijfslogica toe te voegen en te communiceren met de bibliotheken-API.
3. Een instantie maken en de openlaag functie opent de laag zonder de consentmanager, als het nodig is. Als er al toestemming is gegeven, worden de opties en instellingen aan de gebruiker getoond. Het procesverloop ziet er als volgt uit:
Voor meer informatie over ons SDK-versieoverzicht en changelog verwijzen wij u naar deze link.
Installatie via NPM
npm install cmp-sdk
Koppelen (React Native 0.59 en lager)
Als u React Native 0.59 of lager gebruikt, moet u de native modules handmatig koppelen:
react-native link cmp-sdk
Importeer de Consentmanager
aan de hand van de cmp-sdk
verpak in uw code:
import { Consentmanager } from 'cmp-sdk';
2. Initialiseren van de SDK
U kunt de CMP SDK initialiseren met behulp van de directe configuratie of een configuratieobject:
Directe initialisatie:
Consentmanager.createInstance('Code-ID from consentmanager, e.g. bfa712361a....',
'Server-Domain from consentmanager, e.g. delivery.consentmanager.net',
'App Name, e.g. MyReactApp',
'Language, e.g. FR');
Initialisatie met behulp van Config Object:
Consentmanager.createInstanceByConfig(yourConfigObject);
3. De SDK gebruiken
De toestemmingslaag beheren:
Toestemmingslaag openen:
Consentmanager.openConsentlayer();
Afhandeling van evenementen
Voeg gebeurtenislisteners toe om verschillende toestemmingsgerelateerde gebeurtenissen af te handelen:
const removeListeners = Consentmanager.addEventListeners({
onOpen: () => console.log('Consent layer opened'),
onClose: () => console.log('Consent layer closed'),
// Add other event handlers as needed
});
Vergeet niet de gebeurtenislisteners te verwijderen wanneer ze niet langer nodig zijn:
removeListeners();
Toestemmingsvragen
U kunt controleren op toestemmingen van leveranciers en doeleinden:
Controleer de toestemming van de leverancier:
Consentmanager.hasVendor('vendorID').then((hasConsent) => {
console.log('Has vendor consent: ', hasConsent);
});
Controleer doeltoestemming:
Consentmanager.hasPurpose('purposeID').then((hasConsent) => {
console.log('Has purpose consent: ', hasConsent);
});
Toestemming opnieuw instellen
Consentmanager.reset();
Toestemmingsreeks exporteren
Consentmanager.exportCmpString().then((cmpString) => {
console.log('CMP String: ', cmpString);
});
Aanvullende methoden
De CMP SDK biedt verschillende methoden om toestemmingsgegevens op te halen of te beheren, zoals:
getAllVendors()
getAllPurposes()
getEnabledVendors()
getEnabledPurposes()
getDisabledVendors()
getDisabledPurposes()
getUSPrivacyString()
getGoogleACString()
Raadpleeg de SDK-documentatie voor gedetailleerde informatie over deze methoden.