In diesem Entwicklerhandbuch finden Sie Anweisungen, wie Sie mit der Verwendung der Offer Library-API beginnen können. Das Handbuch enthält Beispiel-API-Aufrufe für die Durchführung wichtiger Operationen mit der Decisioning-Engine.
➡️ Weitere Informationen zu den Komponenten des Entscheidungs-Managements finden Sie in diesem Video
Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:
In diesem Handbuch 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
Um Aufrufe an Adobe Experience Platform APIs verwenden, müssen Sie zunächst die Authentifizierungs-Tutorial. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Header in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
Bei allen Anfragen mit einer Payload (POST, PUT, PATCH) ist eine zusätzliche Kopfzeile erforderlich:
Content-Type: application/json
Ein Container ist ein Isolationsmechanismus, der unterschiedliche Aufgaben voneinander trennt. Die Container-ID ist das erste Pfadelement für alle Repository-APIs. Alle Entscheidungsobjekte befinden sich in einem Container.
Ein Administrator kann ähnliche Prinzipale, Ressourcen und Zugriffsberechtigungen in Profilen anordnen. Dies verringert den Verwaltungsaufwand und wird von der Adobe Admin Console unterstützt. Sie müssen in Ihrem Unternehmen ein Produktadministrator für Adobe Experience Platform sein, um Profile erstellen und mit Benutzern verknüpfen zu können. Es reicht aus, in einem einmaligen Schritt Produktprofile einzurichten, die bestimmten Berechtigungen entsprechen, und diesen Profilen dann einfach Benutzer hinzuzufügen. Profile dienen als Gruppen, denen Berechtigungen erteilt wurden; alle echten Benutzer oder technischen Benutzer in dieser Gruppe erben diese Berechtigungen.
Mit Administratorberechtigungen können Sie Benutzern Berechtigungen erteilen oder entziehen, indem Sie Adobe Admin Console. For more information, see the Access control overview.
API-Format
GET /{ENDPOINT_PATH}?product={PRODUCT_CONTEXT}&property={PROPERTY}==decisioning
Parameter | Beschreibung | Beispiel |
---|---|---|
{ENDPOINT_PATH} |
Der Endpunktpfad für Repository-APIs. | https://platform.adobe.io/data/core/xcore/ |
{PRODUCT_CONTEXT} |
Filtert die Liste mit Containern anhand ihrer Verknüpfung mit Produktkontexten. | acp |
{PROPERTY} |
Filtert die Art des zurückgegebenen Containers. | _instance.containerType==decisioning |
Anfrage
curl -X GET \
'https://platform.adobe.io/data/core/xcore/?product=acp&property=_instance.containerType==decisioning' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Antwort
Bei einer erfolgreichen Antwort werden Informationen zu Entscheidungs-Management-Containern zurückgegeben. Dazu gehört ein instanceId
-Attribut, dessen Wert Ihre Container-ID ist.
{
"_embedded": {
"https://ns.adobe.com/experience/xcore/container": [
{
"instanceId": "{INSTANCE_ID}",
"schemas": [
"https://ns.adobe.com/experience/xcore/container;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 2,
"repo:createdDate": "2020-09-16T07:54:28.319959Z",
"repo:lastModifiedDate": "2020-09-16T07:54:32.098139Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"containerType": "decisioning",
"repo:name": "{REPO_NAME}",
"dataCenter": "{DATA_CENTER}",
"parentName": "{PARENT_NAME}",
"parentId": "{PARENT_ID}"
},
"_links": {
"self": {
"href": "/containers/{INSTANCE_ID}"
}
}
}
]
},
"_links": {
"self": {
"href": "/?product=acp&property=_instance.containerType==decisioning",
"@type": "https://ns.adobe.com/experience/xcore/hal/home"
}
}
}
In diesem Dokument ging es um die vorausgesetzten Kenntnisse, die zum Ausführen von Aufrufen an die Offer Library-API benötigt werden, einschließlich der Beschaffung Ihrer Container-ID. Sie können nun mit den Beispielaufrufen in diesem Entwicklerhandbuch fortfahren und den entsprechenden Anweisungen folgen.
Im folgenden Video werden die Komponenten des Entscheidungs-Managements erklärt.