Privacy Service API-Handbuch

Adobe Experience Platform Privacy Service bietet eine RESTful-API und eine Benutzeroberfläche, mit der Sie die personenbezogenen Daten Ihrer betroffenen Personen (Kunden) in Adobe Experience Cloud-Anwendungen verwalten (aufrufen und löschen) können. 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, die Experience Cloud Anwendungen betreffen.

In diesem Handbuch wird die Verwendung der Privacy Service-API behandelt. Weitere Informationen zur Verwendung der Benutzeroberfläche finden Sie in der Übersicht über die Privacy Service-Benutzeroberfläche. Eine umfassende Liste aller verfügbaren Endpunkte in der Privacy Service-API finden Sie unter API-Referenz.

Erste Schritte

Dieses Handbuch erfordert ein Verständnis der folgenden Experience Platform-Funktionen:

  • Privacy Service: Bietet eine RESTful-API und eine Benutzeroberfläche, mit der Sie die Zugriffs- und Löschanfragen Ihrer Datensubjekte (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 Fehlerbehebungshandbuch für Experience Platform

Sammeln von Werten für erforderliche Kopfzeilen

Um Aufrufe an die Privacy Service-API durchzuführen, müssen Sie zunächst Ihre Zugriffsberechtigungen erfassen, um in den erforderlichen Headern 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 in Adobe Admin Console und das Generieren der Anmeldeinformationen in Adobe Developer Console.

Zugriff für Entwickler auf Experience Platform

Um Entwicklern Zugriff auf Platform zu gewähren, 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 Service 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} müssen nur einmal generiert werden und können in zukünftigen API-Aufrufen wiederverwendet werden. Ihr {ACCESS_TOKEN} ist jedoch temporär und muss alle 24 Stunden neu generiert werden.

Die Schritte zum Generieren dieser Werte werden nachfolgend detailliert beschrieben.

Einmalige Einrichtung

Wechseln Sie zu Adobe Developer Console und melden Sie sich bei Ihrem Adobe ID an. Führen Sie anschließend die Schritte aus, die im Lernprogramm Erstellen eines leeren Projekts in der Adobe Developer Console-Dokumentation beschrieben werden.

Nachdem Sie ein neues Projekt erstellt haben, wählen Sie im Bildschirm Projektübersicht die Option Hinzufügen-API.

Der Bildschirm Hinzufügen eine API wird angezeigt. Wählen Sie Privacy Service-API aus der Liste der verfügbaren APIs, bevor Sie Weiter auswählen.

Der Bildschirm API konfigurieren wird angezeigt. Wählen Sie die Option Generate a key pair und wählen Sie Generate keypair in der unteren rechten Ecke.

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 Seite Übersicht über die 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 {API_KEY} dafür erforderliche Client-ID, die im Header x-api-key angegeben werden muss.
  • 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 Ihr {ACCESS_TOKEN}, das 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 Platform-APIs verwenden zu können.

Um ein neues {ACCESS_TOKEN} zu erstellen, öffnen Sie den zuvor heruntergeladenen privaten Schlüssel und fügen Sie den Inhalt in das Textfeld neben Zugriffstoken ein, bevor Sie Token generieren auswählen.

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 Bearer {ACCESS_TOKEN} angegeben werden.

Nächste Schritte

Nachdem Sie wissen, welche Header verwendet werden sollen, können Sie mit dem Aufrufen der Privacy Service-API beginnen. Das Dokument zu Datenschutzaufträgen führt durch die verschiedenen API-Aufrufe, die Sie mit der Privacy Service-API durchführen können. Jeder Beispielaufruf enthält das allgemeine API-Format, eine Beispielanfrage mit den erforderlichen Kopfzeilen und eine Beispielantwort.

Auf dieser Seite

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now