Aktualisieren von Konten mithilfe der Flow Service-API
Unter bestimmten Umständen kann es erforderlich sein, die Details einer vorhandenen Basisverbindung zu aktualisieren. Flow Service bietet Ihnen die Möglichkeit, Details einer vorhandenen Batch- oder Streaming-Verbindung, einschließlich Name, Beschreibung und Anmeldedaten, hinzuzufügen, zu bearbeiten und zu löschen.
In diesem Tutorial werden die Schritte zum Aktualisieren der Details und Anmeldedaten einer Verbindung mithilfe der Flow Service -API beschrieben.
TIPPErste Schritte
Für dieses Tutorial benötigen Sie eine vorhandene Verbindung und eine gültige Verbindungs-ID. Wenn Sie noch keine Verbindung haben, wählen Sie die gewünschte Quelle aus der Übersicht über Quellen und führen Sie vor diesem Tutorial die beschriebenen Schritte aus.
Dieses Tutorial setzt außerdem ein Grundverständnis der folgenden Komponenten von Adobe Experience Platform voraus:
- Quellen: Experience Platform ermöglicht die Aufnahme von Daten aus verschiedenen Quellen und bietet Ihnen die Möglichkeit, die eingehenden Daten mithilfe von Experience Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
- Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Experience Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse besser entwickeln und weiterentwickeln können.
Verwenden von Experience Platform-APIs
Informationen zum erfolgreichen Aufrufen von Experience Platform-APIs finden Sie im Handbuch unter mit Experience Platform-APIs.
Nachschlagen von Verbindungsdetails
Der erste Schritt beim Aktualisieren Ihrer Verbindung besteht darin, ihre Details mithilfe Ihrer Verbindungs-ID abzurufen. Um die aktuellen Details Ihrer Verbindung abzurufen,stellen Sie eine GET-Anfrage an die Flow Service-API und geben Sie dabei die Verbindungs-ID der Verbindung an, die Sie aktualisieren möchten.
API-Format
GET /connections/{CONNECTION_ID}
| Parameter | Beschreibung |
|---|---|
{CONNECTION_ID} | Der eindeutige id-Wert für die Verbindung, die Sie abrufen möchten. |
Anfrage
Mit der folgenden Anfrage werden Informationen zu Ihrer Verbindung abgerufen.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/139f6a5f-a78b-4744-9f6a-5fa78bd74431' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Antwort
Bei einer erfolgreichen Antwort werden die aktuellen Details Ihrer Verbindung zurückgegeben, einschließlich der Anmeldedaten, der eindeutigen Kennung (id) und der Version. Der Versionswert ist erforderlich, um Ihre Verbindung zu aktualisieren.
{
"items": [
{
"createdAt": 1597973312000,
"updatedAt": 1597973312000,
"createdBy": "{CREATED_BY}",
"updatedBy": "{UPDATED_BY}",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxName": "{SANDBOX_NAME}",
"id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
"name": "E2E_SF Base_Connection",
"connectionSpec": {
"id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
"version": "1.0"
},
"state": "enabled",
"auth": {
"specName": "Basic Authentication",
"params": {
"securityToken": "{SECURITY_TOKEN}",
"password": "{PASSWORD}",
"username": "my-salesforce-account",
"environmentUrl": "login.salesforce.com"
}
},
"version": "\"1400dd53-0000-0200-0000-5f3f23450000\"",
"etag": "\"1400dd53-0000-0200-0000-5f3f23450000\""
}
]
}
Aktualisieren der Verbindung
Um den Namen, die Beschreibung und die Anmeldedaten Ihrer Verbindung zu aktualisieren, führen Sie eine PATCH-Anfrage an die Flow Service-API durch und geben Sie dabei Ihre Verbindungs-ID, die Version und die neuen Informationen an, die Sie verwenden möchten.
WICHTIGIf-Match-Kopfzeile ist bei einer PATCH-Anfrage erforderlich. Der Wert für diese Kopfzeile ist die eindeutige Version der Verbindung, die Sie aktualisieren möchten.API-Format
PATCH /connections/{CONNECTION_ID}
| Parameter | Beschreibung |
|---|---|
{CONNECTION_ID} | Der eindeutige id-Wert für die Verbindung, die Sie aktualisieren möchten. |
Anfrage
Die folgende Anfrage enthält einen neuen Namen und eine neue Beschreibung sowie einen neuen Satz von Anmeldedaten, mit denen Sie Ihre Verbindung aktualisieren können.
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/connections/139f6a5f-a78b-4744-9f6a-5fa78bd74431' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-H 'If-Match: 1400dd53-0000-0200-0000-5f3f23450000' \
-d '[
{
"op": "replace",
"path": "/auth/params",
"value": {
"username": "salesforce-connector-username",
"password": "{NEW_PASSWORD}",
"securityToken": "{NEW_SECURITY_TOKEN}"
}
},
{
"op": "replace",
"path": "/name",
"value": "Test salesforce connection"
},
{
"op": "add",
"path": "/description",
"value": "A test salesforce connection"
}
]'
| Parameter | Beschreibung |
|---|---|
op | Der Operationsaufruf, der für die Definition der zum Aktualisieren der Verbindung erforderlichen Aktion verwendet wird. Die Operationen umfassen add, replace und remove. |
path | Der Pfad des zu aktualisierenden Parameters. |
value | Der neue Wert, mit dem Sie Ihren Parameter aktualisieren möchten. |
Antwort
Bei einer erfolgreichen Antwort werden Ihre Verbindungs-ID und ein aktualisiertes eTag zurückgegeben. Sie können die Aktualisierung überprüfen, indem Sie eine GET-Anfrage an die Flow Service-API stellen und dabei Ihre Verbindungs-ID angeben.
{
"id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}