Authentifizierung und Zugriff auf die Privacy Service-API
In diesem Handbuch erhalten Sie eine Einführung in die wichtigsten Konzepte, die Sie kennen müssen, bevor Sie Aufrufe an die Adobe Experience Platform Privacy Service-API durchführen.
Voraussetzungen prerequisites
Dieses Handbuch setzt ein Verständnis von Privacy Service voraus und wie Sie damit Zugriffs- und Löschanfragen Ihrer Datensubjekte (Kunden) in allen Adobe Experience Cloud-Anwendungen verwalten können.
Um Zugriffsberechtigungen für die API zu erstellen, muss ein Administrator in Ihrem Unternehmen zuvor Produktprofile für den Privacy Service in Adobe Admin Console eingerichtet haben. Das Produktprofil, das Sie einer API-Integration zuweisen, bestimmt, welche Berechtigungen diese Integration beim Zugriff auf Privacy Service-Funktionen besitzt. Weitere Informationen finden Sie im Handbuch zum Verwalten von Privacy Service-Berechtigungen .
Sammeln von Werten für erforderliche Kopfzeilen gather-values-required-headers
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}
Diese Werte werden mit Adobe Developer Console generiert. Ihre {ORG_ID} und {API_KEY} müssen nur einmal generiert werden und können in zukünftigen API-Aufrufen wiederverwendet werden. Ihre {ACCESS_TOKEN} ist jedoch temporär und muss alle 24 Stunden neu generiert werden.
Die Schritte zum Generieren dieser Werte werden im Folgenden detailliert beschrieben.
Einmalige Einrichtung one-time-setup
Wechseln Sie zur Adobe-Entwicklerkonsole und melden Sie sich mit Ihrer Adobe ID an. Führen Sie anschließend die im Tutorial Erstellen eines leeren Projekts in der Dokumentation zur Entwicklerkonsole beschriebenen Schritte aus.
Nachdem Sie ein neues Projekt erstellt haben, wählen Sie Zum Projekt hinzufügen und dann API aus dem Dropdown-Menü.
Privacy Service-API auswählen select-privacy-service-api
Der Bildschirm API hinzufügen wird angezeigt. Wählen Sie Experience Cloud aus, um die Liste der verfügbaren APIs einzuschränken, und wählen Sie dann die Karte für die Privacy Service-API aus, bevor Sie Weiter auswählen.
Wählen Sie anschließend den Authentifizierungstyp aus, um Zugriffstoken zu generieren und auf die Privacy Service-API zuzugreifen.
Berechtigungen über Produktprofile zuweisen product-profiles
Der letzte Konfigurationsschritt besteht darin, die Produktprofile auszuwählen, von denen diese Integration ihre Berechtigungen erbt. Wenn Sie mehr als ein Profil auswählen, werden die zugehörigen Berechtigungssätze für die Integration kombiniert.
Wählen Sie abschließend Konfigurierte API speichern aus.
Nachdem die API zum Projekt hinzugefügt wurde, zeigt die Seite Privacy Service-API für das Projekt die folgenden Anmeldeinformationen an, die für alle Aufrufe an Privacy Service-APIs erforderlich sind:
{API_KEY}(Client-ID){ORG_ID}(Organisations-ID)
Authentifizierung für jede Sitzung authentication-each-session
Die letzte erforderliche Berechtigung, die Sie erfassen müssen, ist Ihre {ACCESS_TOKEN}, die in der Autorisierungskopfzeile verwendet wird. Im Gegensatz zu den Werten für {API_KEY} und {ORG_ID} muss alle 24 Stunden ein neues Token generiert werden, um die API weiterhin verwenden zu können.
Im Allgemeinen gibt es zwei Methoden zum Generieren eines Zugriffstokens:
- Generieren Sie das Token manuell zum Testen und Entwickeln.
- Automatisieren der Tokengenerierung für API-Integrationen.
Manuelles Generieren eines Tokens manual-token
Um manuell einen neuen {ACCESS_TOKEN} zu generieren, navigieren Sie zu Anmeldeinformationen > OAuth Server-to-Server und wählen Sie Zugriffstoken generieren, wie unten dargestellt.
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 Authorization-Header verwendet und muss im Format Bearer {ACCESS_TOKEN} angegeben werden.
Token-Generierung automatisieren auto-token
Sie können auch eine Postman-Umgebung und -Sammlung verwenden, um Zugriffstoken zu generieren. Weitere Informationen finden Sie im Abschnitt über die Verwendung von Postman zum Authentifizieren und Testen von API-Aufrufen🔗 im Experience Platform API-Authentifizierungshandbuch.
Lesen von Beispiel-API-Aufrufen read-sample-api-calls
Jedes Endpunkthandbuch enthält Beispiel-API-Aufrufe, die zeigen, wie Sie Ihre Anfragen formatieren. 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 Erste-Schritte-Handbuch für Platform-APIs.
Nächste Schritte next-steps
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: