Erste Schritte mit der Policy Service-API

Mit der Policy Service-API können Sie verschiedene Ressourcen im Zusammenhang mit der Data Governance von Adobe Experience Platform erstellen und verwalten. In diesem Dokument erhalten Sie eine Einführung in die wichtigsten Konzepte, die Sie kennen sollten, bevor Sie Aufrufe an die Policy Service-API durchführen.

Voraussetzungen

Die Verwendung des Entwicklerhandbuchs erfordert ein grundlegendes Verständnis der verschiedenen Experience Platform-Services, die bei der Arbeit mit Data Governance-Funktionen zum Einsatz kommen. Bevor Sie Policy Service API nutzen, lesen Sie die Dokumentation für folgende Services:

  • Data Governance: Das Framework, mit dem Experience Platform die Einhaltung von Datennutzungsregeln erzwingt.
  • Experience Data Model (XDM) System: Das standardisierte Framework, mit dem Experience Platform Kundenerlebnisdaten organisiert.
  • Real-time Customer Profile: Bietet ein einheitliches Echtzeit-Kundenprofil, das auf aggregierten Daten aus verschiedenen Quellen basiert.
  • Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse entwickeln und weiterentwickeln können.

Lesen von Beispiel-API-Aufrufen

In der Dokumentation der Policy Service-API 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 Handbuch zur Fehlerbehebung für Experience Platform

Erforderliche Kopfzeilen

Außerdem setzt die API-Dokumentation voraus, dass Sie das Authentifizierungs-Tutorial abgeschlossen haben, um Platform-Endpunkte erfolgreich aufrufen zu können. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Kopfzeilen in Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:

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

Alle Ressourcen in Experience Platform, einschließlich der Ressourcen, die zu Data Governance gehören, werden in bestimmten virtuellen Sandboxes isoliert. Bei allen Anfragen an Platform-APIs ist eine Kopfzeile erforderlich, die den Namen der Sandbox angibt, in der der Vorgang ausgeführt werden soll:

  • x-sandbox-name: {SANDBOX_NAME}
HINWEIS

Weitere Informationen zu Sandboxes in Platform finden Sie in der Sandbox-Übersichtsdokumentation.

Bei allen Anfragen mit einer Payload (POST, PUT, PATCH) ist eine zusätzliche Kopfzeile erforderlich:

  • Content-Type: application/json

Kernressourcen und benutzerdefinierte Ressourcen

Innerhalb der Policy Service-API werden alle Richtlinien und Marketing-Aktionen entweder als core- oder als custom-Ressourcen bezeichnet.

core-Ressourcen sind die von Adobe definierten und verwalteten Ressourcen, während custom-Ressourcen von Ihrer Organisation erstellt und verwaltet werden und daher einzigartig und nur für Ihre IMS-Organisation sichtbar sind. Darum sind Auflistungs- und Nachschlagevorgänge (GET) die einzigen Vorgänge, die bei core-Ressourcen zulässig sind, während bei custom-Ressourcen Auflistungs-, Nachschlage- und Aktualisierungsvorgänge (POST, PUT, PATCH und DELETE) verfügbar sind.

Nächste Schritte

Um mit dem Aufrufen der Richtlinien-Service-API zu beginnen, wählen Sie eines der verfügbaren Handbücher zu Endpunkten.

Auf dieser Seite