在某些情況下,可能需要更新現有源連接的詳細資訊。 Flow Service 可讓您新增、編輯和刪除現有批次或串流連線的詳細資訊,包括其名稱、說明和憑證。
本教學課程涵蓋使用更新連線的詳細資訊和憑證的步驟 Flow Service API.
本教學課程要求您具備現有連線和有效的連線ID。 如果您沒有現有連線,請從 來源概觀 並遵循在嘗試本教學課程之前概述的步驟。
本教學課程也需要您妥善了解下列Adobe Experience Platform元件:
如需如何成功呼叫Platform API的詳細資訊,請參閱 Platform API快速入門.
更新連線的第一步,是使用連線ID擷取其詳細資訊。 若要擷取連線的目前詳細資料,請向 Flow Service 提供您要更新之連線的連線ID時的API。
API格式
GET /connections/{CONNECTION_ID}
參數 | 說明 |
---|---|
{CONNECTION_ID} |
唯一 id 值。 |
要求
下列要求會擷取您連線的相關資訊。
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}'
回應
成功的回應會傳回連線的目前詳細資訊,包括其憑證、唯一識別碼(id
)和版本。 更新連線需要版本值。
{
"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\""
}
]
}
若要更新連線的名稱、說明和憑證,請向 Flow Service API,同時提供您的連線ID、版本,以及您想使用的新資訊。
此 If-Match
提出PATCH請求時需要標題。 此標題的值是您要更新的連線的唯一版本。
API格式
PATCH /connections/{CONNECTION_ID}
參數 | 說明 |
---|---|
{CONNECTION_ID} |
唯一 id 值。 |
要求
以下請求會提供新名稱和說明,以及一組新的憑證,以更新您的連線。
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"
}
]'
參數 | 說明 |
---|---|
op |
用來定義更新連線所需動作的操作呼叫。 操作包括: add , replace ,和 remove . |
path |
要更新的參數的路徑。 |
value |
您要用更新參數的新值。 |
回應
成功的回應會傳回連線ID和更新的etag。 您可以向 Flow Service API,同時提供您的連線ID。
{
"id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}
依照本教學課程,您已使用 Flow Service API。 有關使用源連接器的詳細資訊,請參閱 來源概觀.