Erste Schritte mit der Privacy Service-API

Dieses Handbuch bietet eine Einführung in die wichtigsten Konzepte, die Sie kennen müssen, bevor Sie Aufrufe an die Privacy Service-API durchführen.

Voraussetzungen

Dieses Handbuch setzt ein Verständnis der folgenden Funktionen voraus:

  • Adobe Experience Platform Privacy Service: Bietet eine RESTful-API und eine Benutzeroberfläche, mit der Sie Zugriffs- und Löschanfragen Ihrer Datensubjekte (Kunden) in allen Adobe Experience Cloud-Anwendungen verwalten können.

Sammeln von Werten für erforderliche Kopfzeilen

Um die Privacy Service-API aufrufen zu können, 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: {ORG_ID}

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

Erhalten von Entwicklerzugriff auf Experience Platform

So erhalten Sie Entwicklerzugriff auf PlatformFühren Sie die ersten Schritte im Abschnitt Tutorial zur Experience Platform-Authentifizierung. Sobald Sie den Schritt "Zugangsdaten in der Adobe Developer Console generieren"erreicht haben, kehren Sie zu diesem Tutorial zurück, um die spezifischen Anmeldeinformationen für Privacy Service zu generieren.

Generieren von Zugriffsberechtigungen

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

  • {ORG_ID}
  • {API_KEY}
  • {ACCESS_TOKEN}

Ihre {ORG_ID} und {API_KEY} muss nur einmal generiert werden und kann in zukünftigen API-Aufrufen wiederverwendet werden. Allerdings muss Ihre {ACCESS_TOKEN} ist temporär und muss alle 24 Stunden neu generiert 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.

Nachdem Sie ein neues Projekt erstellt haben, wählen Sie API hinzufügen auf Projektübersicht angezeigt.

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

Die API konfigurieren angezeigt. Wählen Sie die zu Generieren eines Schlüsselpaars, wählen Sie Generieren von keypair unten rechts.

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 (um in einem späteren Schritt verwendet zu werden). Auswählen Konfigurierte API speichern , um die Konfiguration abzuschließen.

Nachdem die API zum Projekt hinzugefügt wurde, wird die Projektseite erneut auf der Übersicht über die Privacy Service-API Seite. Scrollen Sie von hier nach unten zum Dienstkonto (JWT) -Abschnitt, 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 muss in der x-api-key -Kopfzeile angegeben werden.
  • ORGANISATIONS-ID: Die Organisations-ID ist die {ORG_ID} -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}, der in der Autorisierungskopfzeile verwendet wird. Im Gegensatz zu den Werten für {API_KEY} und {ORG_ID}muss ein neues Token alle 24 Stunden generiert werden, damit Sie weiterhin Platform APIs.

So generieren Sie eine neue {ACCESS_TOKEN}, öffnen Sie den zuvor heruntergeladenen privaten Schlüssel und fügen Sie seinen Inhalt in das Textfeld neben Zugriffstoken generieren vor der Auswahl Generate Token.

Es wird ein neues Zugriffs-Token generiert und eine Schaltfläche zum Kopieren des Tokens in die Zwischenablage bereitgestellt. Dieser Wert wird für die erforderliche Autorisierungskopfzeile 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 zum Lesen von Beispiel-API-Aufrufen in den Ersten Schritten für Platform-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 Endpunktleitfäden für die ersten Schritte aus:

Auf dieser Seite