Show Menu
THEMEN×

Privacy Service Entwicklerhandbuch

Adobe Experience Platform Privacy Service provides a RESTful API and user interface that allow you to manage (access and delete) the personal data of your data subjects (customers) across Adobe Experience Cloud applications. Privacy Service bietet außerdem einen zentralen Audit- und Protokollierungsmechanismus, mit dem Sie auf den Status und die Ergebnisse von Aufträgen zugreifen können, an denen Experience Cloud Anwendungen beteiligt sind.
This guide covers how to use the Privacy Service API. Weitere Informationen zur Verwendung der Benutzeroberfläche finden Sie in der Übersicht über die Privacy Service-Benutzeroberfläche . For a comprehensive list of all available endpoints in the Privacy Service API, please see the API reference .

Erste Schritte

This guide requires a working understanding the following Experience Platform features:
  • -Privacy Service : Bietet eine RESTful-API und eine Benutzeroberfläche, mit der Sie Zugriff auf und Löschanforderungen von Ihren Datensubjekten (Kunden) in allen Adobe Experience Cloud-Anwendungen verwalten können.
Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um die Privacy Service-API erfolgreich aufrufen zu können.

Lesen von Beispiel-API-Aufrufen

In diesem Tutorial wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform

Sammeln von Werten für erforderliche Kopfzeilen

Um die Privacy Service API aufrufen zu können, müssen Sie zunächst Ihre Zugriffsberechtigungen erfassen, um in den erforderlichen Kopfzeilen verwendet werden zu können:
  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Hierzu gehört das Abrufen von Entwicklerberechtigungen für Experience Platform das Adobe Admin Console und das Generieren der Berechtigungen in der Adobe Developer Console.

Entwicklerzugriff erhalten Experience Platform

Um Entwicklern Zugriff auf Platformzu erhalten, führen Sie die ersten Schritte im Tutorial zur Experience Platform-Authentifizierung durch . Sobald Sie den Schritt "Anmeldeinformationen für den Zugriff in der Adobe Developer Console erstellen"erreicht haben, kehren Sie zu diesem Lernprogramm zurück, um die spezifischen Anmeldeinformationen für Privacy Servicedieses Lernprogramm zu generieren.

Zugriffsberechtigungen generieren

Mit der Adobe Developer Console müssen Sie die folgenden drei Zugriffsberechtigungen generieren:
  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}
Ihre {IMS_ORG} und {API_KEY} nur einmal generiert werden müssen und können in zukünftigen API-Aufrufen wiederverwendet werden. Ihre {ACCESS_TOKEN} Daten sind jedoch nur vorübergehend und müssen alle 24 Stunden neu generiert werden.
Die Schritte zum Generieren dieser Werte werden nachfolgend detailliert beschrieben.

Einmalige Einrichtung

Go to Adobe Developer Console and sign in with your Adobe ID. Führen Sie anschließend die im Lernprogramm zum Erstellen eines leeren Projekts in der Dokumentation zur Adobe Developer Console beschriebenen Schritte aus.
Nachdem Sie ein neues Projekt erstellt haben, klicken Sie im Bildschirm " Projektübersicht "auf Hinzufügen API .
Der Hinzufügen eines API -Bildschirms wird angezeigt. Wählen Sie Privacy Service-API aus der Liste der verfügbaren APIs, bevor Sie auf Weiter klicken.
Der Bildschirm API konfigurieren wird angezeigt. Wählen Sie die Option zum Generieren eines Schlüsselpaars aus und klicken Sie dann unten rechts auf Generate keypair .
Das Schlüsselpaar wird automatisch generiert und eine ZIP-Datei mit einem privaten Schlüssel und einem öffentlichen Zertifikat wird auf Ihren lokalen Computer heruntergeladen (in einem späteren Schritt zu verwenden). Wählen Sie Konfigurierte API speichern , um die Konfiguration abzuschließen.
Nachdem die API zum Projekt hinzugefügt wurde, wird die Projektseite auf der Übersichtsseite zur Privacy Service-API erneut angezeigt. Blättern Sie von hier nach unten zum Abschnitt Dienstkonto (JWT) , der die folgenden Zugriffsberechtigungen bereitstellt, die für alle Aufrufe der Privacy Service API erforderlich sind:
  • CLIENT-ID : Die Client-ID ist die erforderliche {API_KEY} für die Bereitstellung im X-API-Schlüssel-Header.
  • Organisations-ID : Die Organisations-ID ist der {IMS_ORG} Wert, der im Header x-gw-ims-org-id verwendet werden muss.

Authentifizierung für jede Sitzung

Die letzte erforderliche Berechtigung, die Sie erfassen müssen, ist Ihre {ACCESS_TOKEN} , die im Autorisierungs-Header verwendet wird. Im Gegensatz zu den Werten für {API_KEY} und {IMS_ORG} muss alle 24 Stunden ein neues Token generiert werden, um weiterhin mit Platform APIs arbeiten zu können.
Um einen neuen zu generieren, öffnen Sie {ACCESS_TOKEN} den zuvor heruntergeladenen privaten Schlüssel und fügen Sie den Inhalt in das Textfeld neben Zugriffstoken erstellen ein, bevor Sie auf Token generieren klicken.
Es wird ein neues Zugriffstoken generiert und eine Schaltfläche zum Kopieren des Tokens in die Zwischenablage bereitgestellt. Dieser Wert wird für den erforderlichen Autorisierungs-Header verwendet und muss im Format angegeben werden Bearer {ACCESS_TOKEN} .

Nächste Schritte

Now that you understand what headers to use, you are ready to begin making calls to the Privacy Service API. The document on privacy jobs walks through the various API calls you can make using the Privacy Service API. Jeder Beispielaufruf enthält das allgemeine API-Format, eine Beispielanfrage mit den erforderlichen Kopfzeilen und eine Beispielantwort.