Show Menu
THEMEN×

Entwicklerhandbuch für Privacy Service

Adobe Experience Platform Privacy Service bietet eine RESTful-API und eine Benutzeroberfläche, mit der Sie die personenbezogenen Daten Ihrer betroffenen Personen (Kunden) in allen 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 Benutzeroberfläche des Privacy Service . Eine umfassende Liste aller verfügbaren Endpunkte in der Privacy Service-API finden Sie in der API-Referenz .

Erste Schritte

Dieses Handbuch erfordert ein Verständnis der folgenden Funktionen der Experience Platform:
  • Privacy Service : Bietet eine RESTful-API und eine Benutzeroberfläche, mit der Sie den Zugriff auf und das Löschen von Anforderungen Ihrer betroffenen Personen (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 Lernprogramm finden Sie Beispiele für API-Aufrufe, die zeigen, wie Sie Ihre Anforderungen formatieren. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anforderungs-Nutzdaten. Beispiel-JSON, die in API-Antworten zurückgegeben wird, wird ebenfalls 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 bei Experience Platformen.

Werte für erforderliche Kopfzeilen sammeln

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:
  • Genehmigung: Träger {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Hierzu gehört das Abrufen von Entwicklerberechtigungen für die Experience Platform in der Adobe-Admin Console und das Generieren der Anmeldeinformationen in Adobe Developer Console.

Entwicklerzugriff auf Experience Platform

Um Entwicklern Zugriff auf Platformen zu gewähren, führen Sie die ersten Schritte im Experience Platform-Authentifizierungslehrgang aus. 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 für Privacy Service spezifischen Anmeldeinformationen zu generieren.

Zugriffsberechtigungen generieren

Mit 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

Wechseln Sie zur Adobe Developer Console und melden Sie sich bei Ihrer Adobe ID an. Führen Sie anschließend die Schritte aus, die im Lernprogramm zum Erstellen eines leeren Projekts in der Dokumentation zur Adobe Developer Console beschrieben sind.
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 muss {IMS_ORG} alle 24 Stunden ein neues Token generiert werden, um weiterhin Platform-APIs verwenden 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

Jetzt, da Sie wissen, welche Header verwendet werden sollen, können Sie mit dem Aufrufen der Privacy Service-API beginnen. Das Dokument zu Datenschutzaufträgen durchläuft die verschiedenen API-Aufrufe, die Sie mit der Privacy Service-API durchführen können. Zu jedem Beispielaufruf gehören das allgemeine API-Format, eine Beispielanforderung mit den erforderlichen Kopfzeilen und eine Beispielantwort.