使用Flow Service API更新連線資訊

在某些情況下,可能需要更新現有源連接的詳細資訊。 Flow Service 提供您新增、編輯和刪除現有批處理或串流連接詳細資料的能力,包括其名稱、說明和認證。

本教程介紹使用更新現有連接的詳細資訊和憑據的步驟 Flow Service API

快速入門

本教學課程要求您必須有有效的連線ID。 如果您沒有有效的連線ID,請從來源概觀中選取您選擇的連 接器 ,並依照本教學課程前所述的步驟進行。

本教學課程也要求您對Adobe Experience Platform的下列元件有正確的認識:

  • 來源: Experience Platform 允許從各種來源接收資料,同時提供使用服務構建、標籤和增強傳入資料的 Platform 能力。
  • 沙盒: Experience Platform 提供虛擬沙盒,可將單一執行個體分 Platform 割為不同的虛擬環境,以協助開發和發展數位體驗應用程式。

以下各節提供您需要知道的其他資訊,以便使用 Flow Service API成功更新連線資訊。

讀取範例API呼叫

本教學課程提供範例API呼叫,以示範如何設定請求的格式。 這些包括路徑、必要標題和正確格式化的請求負載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所用慣例的詳細資訊,請參閱疑難排解指 南中有關如何讀取範例API呼叫的 Experience Platform 章節。

收集必要標題的值

若要呼叫API,您必 Platform 須先完成驗證教 學課程。 完成驗證教學課程後,將提供所有 Experience Platform API呼叫中每個必要標題的值,如下所示:

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

中的所有資 Experience Platform源(包括屬於這些資源 Flow Service)都隔離到特定的虛擬沙盒。 對API的所 Platform 有請求都需要一個標題,該標題會指定要在中執行的操作的沙盒名稱:

  • x-sandbox-name: {SANDBOX_NAME}

所有包含裝載(POST、PUT、PATCH)的請求都需要額外的媒體類型標題:

  • Content-Type: application/json

查找連接詳細資訊

注意

本教學課程以 Salesforce來源連接器為例 ,但概述的步驟適用於任何可 用來源連接器

更新連線資訊的第一步是使用連線ID擷取連線詳細資訊。

API格式

GET /connections/{CONNECTION_ID}
參數 說明
{CONNECTION_ID} 要檢 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: {IMS_ORG}' \
    -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\""
        }
    ]
}

更新連線

擁有現有連接ID後,請對 Flow Service API執行PATCH請求。

重要

PATCH請求需要使用標 If-Match 頭。 此標題的值是連線的唯一版本。

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: {IMS_ORG}' \
    -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 用於定義更新連接所需操作的操作調用。 運營包括: addreplaceremove
path 要更新的參數路徑。
value 您要用來更新參數的新值。

回應

成功的回應會傳回您的連線ID和更新的etag。

{
    "id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

查找更新的連接詳細資訊

您可以擷取您更新的相同連線ID,以便透過對 Flow Service API進行GET要求來查看您所做的變更。

API格式

GET /connections/{CONNECTION_ID}
參數 說明
{CONNECTION_ID} 要檢 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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回您連線ID的更新詳細資訊,包括其新名稱、說明和版本。

{
    "items": [
        {
            "createdAt": 1597973312000,
            "updatedAt": 1598038319627,
            "createdBy": "{CREATED_BY}",
            "updatedBy": "{UPDATED_BY}",
            "createdClient": "{CREATED_CLIENT}",
            "updatedClient": "{UPDATED_CLIENT}",
            "sandboxName": "{SANDBOX_NAME}",
            "id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
            "name": "Test salesforce connection",
            "description": "A test salesforce connection",
            "connectionSpec": {
                "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
                "version": "1.0"
            },
            "state": "enabled",
            "auth": {
                "specName": "Basic Authentication",
                "params": {
                    "securityToken": "{NEW_SECURITY_TOKEN}",
                    "password": "{PASSWORD}",
                    "username": "salesforce-connector-username"
                }
            },
            "version": "\"3600e378-0000-0200-0000-5f40212f0000\"",
            "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
        }
    ]
}

後續步驟

在本教學課程中,您已使用 Flow Service API更新與您的連線相關的認證和資訊。 如需使用來源連接器的詳細資訊,請參閱來 源概觀

本頁內容