Erste Schritte mit der Privacy Service-API

Dieses Handbuch enthält eine Einführung in die Kernkonzepte, die Sie kennen müssen, bevor Sie Aufrufe der Privacy Service-API durchführen können.

Voraussetzungen

Dieses Handbuch erfordert ein Verständnis der folgenden Funktionen:

  • Adobe Experience Platform Privacy Service: Bietet eine RESTful-API und eine Benutzeroberfläche, mit der Sie Zugriff auf und Löschen von Anforderungen von Ihren Datensubjekten (Kunden) in allen Adobe Experience Cloud-Anwendungen verwalten können.

Sammeln von Werten für erforderliche Kopfzeilen

Um Aufrufe der Privacy Service-API zu tätigen, müssen Sie zunächst Ihre Zugriffsberechtigungen erfassen, damit sie in den erforderlichen Kopfzeilen verwendet werden können:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Dazu gehört das Erlangen von Entwicklerberechtigungen für Adobe Experience Platform in Adobe Admin Console und das anschließende Generieren der Anmeldedaten in der Adobe Developer Console.

Erhalten von Entwicklerzugriff auf Experience Platform

So erhalten Entwickler Zugriff auf Platformfolgen Sie den ersten Schritten in Tutorial zur Experience Platform-Authentifizierung. Sobald Sie im Schritt "Zugangsdaten in der Adobe Developer Console generieren" ankommen, kehren Sie zu diesem Tutorial zurück, um die spezifischen Anmeldedaten für Privacy Service zu generieren.

Generieren von Zugriffsberechtigungen

Mithilfe der Adobe-Entwicklerkonsole müssen Sie die folgenden drei Zugriffsberechtigungen generieren:

  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}

Ihre {IMS_ORG} und {API_KEY} nur einmal generiert werden und in zukünftigen API-Aufrufen wiederverwendet werden können. Allerdings {ACCESS_TOKEN} ist vorübergehend und muss alle 24 Stunden regeneriert werden.

Die Schritte zum Generieren dieser Werte werden im Folgenden detailliert beschrieben.

Einmalige Einrichtung

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

Sobald Sie ein neues Projekt erstellt haben, wählen Sie hinzufügen-API zu Projektübersicht Bildschirm.

Der Bildschirm API hinzufügen wird angezeigt. Auswählen Privacy Service-API aus der Liste der verfügbaren APIs, bevor Sie Weiter.

Die API konfigurieren angezeigt. Option auswählen, um Schlüsselpaar erstellen, wählen Sie Schlüsselbild generieren in der rechten unteren Ecke.

Das Schlüsselpaar wird automatisch erstellt und eine ZIP-Datei mit einem privaten Schlüssel und einem öffentlichen Zertifikat wird auf Ihren lokalen Computer heruntergeladen (um in einem späteren Schritt verwendet zu werden). Auswählen Konfigurierte API speichern , um die Konfiguration abzuschließen.

Sobald die API dem Projekt hinzugefügt wurde, wird die Projektseite auf der Übersicht über die Privacy Service-API Seite. Von hier aus scrollen Sie nach unten zum Dienstkonto (JWT) -Abschnitt, der die folgenden Zugriffsberechtigungen bereitstellt, die bei allen Aufrufen der Privacy Service-API erforderlich sind:

  • CLIENT-ID: Die Client-ID ist erforderlich. {API_KEY} dafür muss im x-api-key-Header angegeben werden.
  • ORGANISATIONS-ID: Die Organisations-ID ist die {IMS_ORG} Wert, der im x-gw-ims-org-id-Header verwendet werden muss.

Authentifizierung für jede Sitzung

Die letzte erforderliche Berechtigung, die Sie sammeln müssen, ist Ihre {ACCESS_TOKEN}, das im Autorisierungskopfabschnitt verwendet wird. Im Gegensatz zu den Werten für {API_KEY} und {IMS_ORG}muss alle 24 Stunden ein neues Token erstellt werden, um weiterhin verwendet werden zu können Platform APIs.

So erstellen Sie ein neues {ACCESS_TOKEN}, öffnen Sie den zuvor heruntergeladenen privaten Schlüssel und fügen Sie den Inhalt in das Textfeld neben Zugriffstoken erstellen vor Auswahl Token generieren.

Es wird ein neues Zugriffs-Token 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}.

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 zu Lesen von Beispiel-API-Aufrufen im Handbuch "Erste Schritte"für Plattform-APIs.

Nächste Schritte

Nachdem Sie nun wissen, welche Kopfzeilen zu verwenden sind, können Sie erste Aufrufe an die Privacy Service-API stellen. Wählen Sie eine der Endpunkt-Hilfslinien, um zu beginnen:

Auf dieser Seite