Documentatie Campaign Documentatie voor Campaign Classic v7

Automatisch proces voor privacyverzoeken automatic-privacy-request-api

Last update: Fri Apr 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Privacytools

Adobe Campaign biedt een API waarmee u een automatisch proces voor verzoeken om toegang tot persoonsgegevens kunt instellen.

Het algemene privacyproces met de API is hetzelfde als met de interface. Het enige verschil is de manier waarop het verzoek om toegang tot persoonsgegevens wordt gemaakt. In plaats van het verzoek in Adobe Campaign te maken, wordt een POST met de gegevens van het verzoek naar Campaign verzonden. Voor elk verzoek wordt een nieuwe vermelding toegevoegd in het scherm Privacy Requests. De technische workflows voor privacy verwerken dan het verzoek. Dit gebeurt op dezelfde manier als voor een verzoek dat via de interface wordt toegevoegd.

Als u de API gebruikt om de privacyverzoeken in te dienen, raden wij u aan het tweestapsproces te activeren voor de eerste verwijderingsverzoeken. Zo kunnen de geretourneerde gegevens worden getest. Na afloop van de tests kunt u het tweestapsproces deactiveren zodat het proces voor verwijderingsverzoeken automatisch kan worden uitgevoerd.

De CreateRequestByName JS-API wordt als volgt gedefinieerd.

NOTE

Als u de gdprRequest-API gebruikte, kunt u deze nog steeds gebruiken, maar we raden u aan de nieuwe privacyRequest-API te gebruiken.

IMPORTANT

Het opgegeven recht Privacy Data Right is vereist om de API te gebruiken.

<method library="nms:gdpr.js" name="CreateRequestByName" static="true">
 <help>Create a new GDPR Request using namespace internal name</help>
 <parameters>
  <param name="namespaceName" type="string" desc="Namespace internal name"/>
  <param name="reconciliationValue" type="string" desc="Reconciliation value"/>
  <param name="type" type="long" desc="Reconciliation value"/>
  <param name="confirmDeletePending" type="boolean" desc="Request confirm before deleting data"/>
  <param name="regulation" type="long" desc="regulation of newly created request"/>
  <param name="id" type="long" inout="out" desc="ID of newly created request"/>
 </parameters>
</method>

NOTE

Het veld 'regulation' is alleen beschikbaar als u Campaign Classic 20.2 (build 9178+) gebruikt.

Als u naar 20.2 migreert en de API voorheen al gebruikte, moet u het veld ‘regulation’ toevoegen, zoals hierboven is aangegeven. Als u een oudere build gebruikt, kunt u de API zonder het veld ‘regulation’ blijven gebruiken.

De API extern aanroepen invoking-api-externally

Hier ziet u een voorbeeld van hoe u de API extern kunt aanroepen, in het bijzonder de verificatie via de API en informatie over de Privacy-API. Raadpleeg de API-documentatie voor meer informatie over de Privacy-API. U kunt ook de documentatie voor webserviceaanroepen raadplegen.

Allereerst moet u de verificatie uitvoeren via de API:

Download de xtk:session-WSDL via deze URL: <server url>/nl/jsp/schemawsdl.jsp?schema=xtk:session.
Gebruik de methode 'Logon' en voer een gebruikersnaam en wachtwoord in als parameters voor het verzoek. U krijgt een antwoord met een sessietoken. Hier volgt een voorbeeld van het gebruik van SoapUI.
Gebruik de geretourneerde sessietoken als verificatie voor alle verdere API-aanroepen. Deze vervalt na 24 uur.

Roep vervolgens de Privacy-API aan:

Download de WSDL via deze URL: <server url>/nl/jsp/schemawsdl.jsp?schema=nms:privacyRequest.
Gebruik CreateRequestByName om een specifiek verzoek voor toegang tot persoonsgegevens te maken.

Hier volgt een voorbeeld met de CreateRequestByName. Bekijk hoe we de hierboven gegenereerde sessietoken gebruiken als verificatie. Het antwoord is de id van het gemaakte verzoek.

Houd rekening met het volgende als u bovenstaande stappen uitvoert:
- U kunt een queryDef op het nms:gdprRequest-schema gebruiken om de status van het toegangsverzoek te controleren.
- U kunt een queryDef op het nms:gdprRequestData-schema gebruiken om het resultaat van het toegangsverzoek te krijgen.
- Om het XML-bestand van "$(serverUrl)'/nms/gdpr.jssp?id='@id" te kunnen downloaden moet u zijn aangemeld en het bestand openen vanaf een IP-adres dat is toegevoegd aan de lijst met gewenste personen. U kunt dit doen door een webapplicatie te maken waarmee u toegang krijgt tot het bestand dat door de JSSP wordt gegenereerd.

De API aanroepen vanuit een JS invoking-api-from-js

Hier is een voorbeeld van hoe u de API vanuit een JS binnen Campaign Classic kunt aanroepen.

NOTE

Het veld 'regulation' is alleen beschikbaar als u Campaign Classic 20.2 (build 9178+) gebruikt.

Als u naar 20.2 migreert en de API voorheen al gebruikte, moet u het veld ‘regulation’ toevoegen. Als u een oudere build gebruikt, kunt u de API zonder het veld ‘regulation’ blijven gebruiken.

Als u een oudere build gebruikt (met AVG-pakket), kunt u de API blijven gebruiken zonder het veld ‘regulation’, zoals hieronder wordt getoond:

code language-none

code language-none
loadLibrary("nms:gdpr.js"); /************************** This code calls an API to create new Privacy request on the DB. It requires 4 parameters below. Feel free to change parameter values. **************************/ // 1. Namespace internal name var namespaceName = "defaultNamespace1"; // 2. Reconciliation value for privacy request var reconciliationValue = "example@adobe.com"; // 3. Privacy request type // GDPR_REQUEST_TYPE_ACCESS = 1; // GDPR_REQUEST_TYPE_DELETE = 2; var requestType = GDPR_REQUEST_TYPE_ACCESS; // 4. Confirm deleting data required. // value : true or false var ConfirmDeletePending = true; // BEGIN var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending); // User can use a simple queryDef with requestID as a parameter to check request status.

loadLibrary("nms:gdpr.js");
/****************************
This code calls an API to create new Privacy request on the DB.
It requires 4 parameters below.
Feel free to change parameter values.
****************************/
// 1. Namespace internal name
var namespaceName = "defaultNamespace1";
// 2. Reconciliation value for privacy request
var reconciliationValue = "example@adobe.com";
// 3. Privacy request type
// GDPR_REQUEST_TYPE_ACCESS = 1;
// GDPR_REQUEST_TYPE_DELETE = 2;
var requestType = GDPR_REQUEST_TYPE_ACCESS;
// 4. Confirm deleting data required.
// value : true or false
var ConfirmDeletePending = true;
// BEGIN
var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending);
// User can use a simple queryDef with requestID as a parameter to check request status.

Als u migreert naar 20.2 en als u de API al gebruikte, moet u het veld ‘regulation’ toevoegen zoals hieronder wordt weergegeven:

code language-none

code language-none
loadLibrary("nms:gdpr.js"); /************************** This code calls an API to create new Privacy request on the DB. It requires 5 parameters below. Feel free to change parameter values. **************************/ // 1. Namespace internal name var namespaceName = "defaultNamespace1"; // 2. Reconciliation value for privacy request var reconciliationValue = "example@adobe.com"; // 3. Privacy request type // PRIVACY_REQUEST_TYPE_ACCESS = 1; // PRIVACY_REQUEST_TYPE_DELETE = 2; var requestType = PRIVACY_REQUEST_TYPE_ACCESS; // 4. Confirm deleting data required. // value : true or false var ConfirmDeletePending = true; // 5. Specify which regulation applies to newly created request. This is mandatory parameter. // GDPR = 1 // CCPA = 2 // PDPA = 3 // LGPD = 4 var regulation = 1; // BEGIN var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending, regulation); // User can use a simple queryDef with requestID as a parameter to check request status.

loadLibrary("nms:gdpr.js");
/****************************
This code calls an API to create new Privacy request on the DB.
It requires 5 parameters below.
Feel free to change parameter values.
****************************/
// 1. Namespace internal name
var namespaceName = "defaultNamespace1";
// 2. Reconciliation value for privacy request
var reconciliationValue = "example@adobe.com";
// 3. Privacy request type
// PRIVACY_REQUEST_TYPE_ACCESS = 1;
// PRIVACY_REQUEST_TYPE_DELETE = 2;
var requestType = PRIVACY_REQUEST_TYPE_ACCESS;
// 4. Confirm deleting data required.
// value : true or false
var ConfirmDeletePending = true;
// 5. Specify which regulation applies to newly created request. This is mandatory parameter.
// GDPR = 1
// CCPA = 2
// PDPA = 3
// LGPD = 4
var regulation = 1;
// BEGIN
var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending, regulation);
// User can use a simple queryDef with requestID as a parameter to check request status.

Als u Campaign Classic 20.2 (build 9178+) of hoger gebruikt, is het veld 'regulation' optioneel, zoals hieronder wordt getoond:

code language-none

code language-none
loadLibrary("nms:gdpr.js"); /************************** This code calls an API to create new Privacy request on the DB. It requires 5 parameters below. Feel free to change parameter values **************************/ // 1. Namespace internal name var namespaceName = "defaultNamespace1"; // 2. Reconciliation value for privacy request var reconciliationValue = "example@adobe.com"; // 3. Privacy request type // PRIVACY_REQUEST_TYPE_ACCESS = 1; // PRIVACY_REQUEST_TYPE_DELETE = 2; var requestType = PRIVACY_REQUEST_TYPE_ACCESS; // 4. Confirm deleting data required. // value : true or false var ConfirmDeletePending = true; // 5. Specify which regulation applies to newly created request. This is optional parameter. // GDPR = 1 // CCPA = 2 // PDPA = 3 // LGPD = 4 var regulation = 1; // BEGIN var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending, regulation); // User can use a simple queryDef with requestID as a parameter to check request status.

loadLibrary("nms:gdpr.js");
/****************************
This code calls an API to create new Privacy request on the DB.
It requires 5 parameters below.
Feel free to change parameter values
****************************/
// 1. Namespace internal name
var namespaceName = "defaultNamespace1";
// 2. Reconciliation value for privacy request
var reconciliationValue = "example@adobe.com";
// 3. Privacy request type
// PRIVACY_REQUEST_TYPE_ACCESS = 1;
// PRIVACY_REQUEST_TYPE_DELETE = 2;
var requestType = PRIVACY_REQUEST_TYPE_ACCESS;
// 4. Confirm deleting data required.
// value : true or false
var ConfirmDeletePending = true;
// 5. Specify which regulation applies to newly created request. This is optional parameter.
// GDPR = 1
// CCPA = 2
// PDPA = 3
// LGPD = 4
var regulation = 1;
// BEGIN
var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending, regulation);
// User can use a simple queryDef with requestID as a parameter to check request status.

recommendation-more-help

601d79c3-e613-4db3-889a-ae959cd9e3e1