建立您的來源使用 Flow Service API

瀏覽此模板時，替換或刪除所有斜體段落（從此模板開始）。

首先，請更新頁面頂端的中繼資料（標題和說明）。請忽略此頁面上的所有DNL實例。這個標籤可協助我們的機器翻譯程式將頁面正確翻譯成我們支援的多種語言。在您提交檔案後，我們會為其新增標籤。

總覽

提供您公司的簡短概觀，包括為客戶提供的價值。加入產品檔案首頁的連結，以供進一步閱讀。

重要

本檔案頁面由 您的來源 團隊。如有任何查詢或更新請求，請直接與他們聯繫，地址為 插入可以聯繫您獲取更新的連結或電子郵件地址.

先決條件

在本節中新增客戶開始在Adobe Experience Platform使用者介面中設定來源之前，需注意之事項的相關資訊。這可以是：

需要添加到允許清單
電子郵件雜湊要求
任何你方的賬戶細節
如何取得API金鑰以連線至您的平台

收集所需憑據

為了連接 您的來源 要Experience Platform，必須為以下連接屬性提供值：

憑據	說明	範例
憑據	請在此處向源的身份驗證憑據添加簡短描述	請在此處添加源的驗證憑據示例
憑證	請在此處向源的身份驗證憑據添加簡短描述	請在此處添加源的驗證憑據示例
憑據三	請在此處向源的身份驗證憑據添加簡短描述	請在此處添加源的驗證憑據示例

如需這些憑證的詳細資訊，請參閱 您的來源 驗證檔案。 請在此處將連結新增至您平台的驗證檔案.

Connect 您的來源到使用 Flow Service API

以下教學課程會逐步引導您完成建立 您的來源 源連接和建立資料流，以便 您的來源 使用 Flow Service API.

建立基本連接

基本連接在源和平台之間保留資訊，包括源的驗證憑據、連接的當前狀態和唯一基本連接ID。基本連線ID可讓您從來源探索和導覽檔案，並識別您要擷取的特定項目，包括其資料類型和格式的相關資訊。

若要建立基本連線ID，請向 /connections 端點提供 您的來源 請求內文的驗證憑證。

API格式

POST /connections

要求

下列請求會為 您的來源:

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/connections' \
    -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 'Content-Type: application/json' \
    -d '{
        "name": "{YOURSOURCE} base connection",
        "description": "{YOURSOURCE} base connection to authenticate to Platform",
        "connectionSpec": {
            "id": "6360f136-5980-4111-8bdf-15d29eab3b5a",
            "version": "1.0"
        },
        "auth": {
            "specName": "OAuth generic-rest-connector",
            "params": {
                "accessToken": "{ACCESS_TOKEN}",
                "refreshToken": "{REFRESH_TOKEN}",
                "expirationDate": "{EXPIRATION_DATE}"
            }
        }
    }'

屬性	說明
`name`	基本連接的名稱。請確定基本連線的名稱是描述性的，因為您可以使用此名稱來查詢基本連線的資訊。
`description`	可包含的選用值，可提供基礎連線的詳細資訊。
`connectionSpec.id`	源的連接規範ID。此ID可在您的來源註冊並透過 Flow Service API。
`auth.specName`	用於向平台驗證源的驗證類型。
`auth.params.`	包含驗證源所需的憑據。

回應

成功的響應返回新建的基本連接，包括其唯一連接標識符(id)。在下一步中，瀏覽源的檔案結構和內容時需要此ID。

{
     "id": "70383d02-2777-4be7-a309-9dd6eea1b46d",
     "etag": "\"d64c8298-add4-4667-9a49-28195b2e2a84\""
}

探索源

使用在上一步中生成的基本連接ID，可以通過執行GET請求來瀏覽檔案和目錄。
使用下列呼叫來尋找您要帶入的檔案路徑 Platform:

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}

執行GET請求以探索源的檔案結構和內容時，必須包括下表中列出的查詢參數：

參數	說明
`{BASE_CONNECTION_ID}`	上一步驟中產生的基本連線ID。
`objectType=rest`	要瀏覽的對象類型。目前，此值一律設為 `rest`.
`{OBJECT}`	只有在查看特定目錄時，才需要此參數。其值表示要瀏覽的目錄的路徑。
`fileType=json`	要帶入Platform的檔案的檔案類型。目前， `json` 是唯一支援的檔案類型。
`{PREVIEW}`	一個布林值，定義連接的內容是否支援預覽。
`{SOURCE_PARAMS}`	定義要帶入Platform的源檔案的參數。要檢索接受的格式類型，請執行以下操作 `{SOURCE_PARAMS}`，您必須將整個 `list_id` base64中的字串。在以下範例中， `"list_id": "10c097ca71"` 在base64等於 `eyJsaXN0SWQiOiIxMGMwOTdjYTcxIn0=`.

要求

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/70383d02-2777-4be7-a309-9dd6eea1b46d/explore?objectType=rest&object=json&fileType=json&preview=true&sourceParams=eyJsaXN0SWQiOiIxMGMwOTdjYTcxIn0=' \
    -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}'

回應

成功的回應會傳回查詢的檔案結構。

{
  "data": [
    {
      "members": [
        {
          "id": "cff65fb4c5f5828666ad846443720efd",
          "email_address": "roykent@gmail.com",
          "unique_email_id": "72c758cbf1",
          "full_name": "Roy Kent",
          "web_id": 547094062,
          "email_type": "html",
          "status": "subscribed",
          "merge_fields": {
            "FNAME": "Roy",
            "LNAME": "Kent",
            "ADDRESS": {
              "addr1": "",
              "addr2": "",
              "city": "Richmond",
              "state": "Virginia",
              "zip": "",
              "country": "US"
            },
            "PHONE": "",
            "BIRTHDAY": ""
          },
          "stats": {
            "avg_open_rate": 0,
            "avg_click_rate": 0
          },
          "ip_signup": "",
          "timestamp_signup": "",
          "ip_opt": "103.43.112.97",
          "timestamp_opt": "2021-06-01T15:31:36+00:00",
          "member_rating": 2,
          "last_changed": "2021-06-01T15:31:36+00:00",
          "language": "",
          "vip": false,
          "email_client": "",
          "location": {
            "latitude": 0,
            "longitude": 0,
            "gmtoff": 0,
            "dstoff": 0,
            "country_code": "",
            "timezone": ""
          },
          "source": "Admin Add",
          "tags_count": 0,
          "tags": [

          ],
          "list_id": "10c097ca71"
        }
      ],
      "list_id": "10c097ca71",
      "total_items": 2,
      "_links": [
        {
          "rel": "self",
          "href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members",
          "method": "GET",
          "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/CollectionResponse.json",
          "schema": "https://us6.api.mailchimp.com/schema/3.0/Paths/Lists/Members/Collection.json"
        },
        {
          "rel": "parent",
          "href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71",
          "method": "GET",
          "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
        },
        {
          "rel": "create",
          "href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members",
          "method": "POST",
          "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json",
          "schema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/POST.json"
        }
      ]
    }
  ]
}

建立源連接

您可以透過向 Flow Service API。源連接由連接ID、源資料檔案的路徑和連接規範ID組成。

API格式

POST /sourceConnections

要求

以下請求將建立源連接 您的來源:

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -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 'Content-Type: application/json' \
    -d '{
        "name": "{YOURSOURCE} Source Connection",
        "description": "{YOURSOURCE} Source Connection",
        "baseConnectionId": "70383d02-2777-4be7-a309-9dd6eea1b46d",
        "connectionSpec": {
            "id": "6360f136-5980-4111-8bdf-15d29eab3b5a",
            "version": "1.0"
        },
        "data": {
            "format": "json"
        },
        "params": {
            "server": "us6",
            "listId": "10c097ca71"
        }
    }'

屬性	說明
`name`	源連接的名稱。請確保源連接的名稱是描述性的，因為您可以使用此名稱查找有關源連接的資訊。
`description`	可包含的選用值，用於提供來源連線的詳細資訊。
`baseConnectionId`	基本連接ID為您的來源. 此ID是在先前的步驟中產生。
`connectionSpec.id`	與源對應的連接規範ID。
`data.format`	格式您的來源您要擷取的資料。目前，唯一支援的資料格式是 `json`.

回應

成功的回應會傳回唯一識別碼(id)。在後續步驟中需要此ID才能建立資料流。

{
     "id": "246d052c-da4a-494a-937f-a0d17b1c6cf5",
     "etag": "\"712a8c08-fda7-41c2-984b-187f823293d8\""
}

建立目標XDM結構

為了在Platform中使用來源資料，必須建立目標架構，以根據您的需求來建構來源資料。然後，目標架構會用來建立包含來源資料的Platform資料集。

您可以透過執行POST要求來建立目標XDM結構結構註冊表API.

如需建立Target XDM結構的詳細步驟，請參閱使用API建立結構.

建立目標資料集

目標資料集的建立方式，是透過對目錄服務API，提供裝載中目標架構的ID。

如需如何建立目標資料集的詳細步驟，請參閱使用API建立資料集.

建立目標連線

目標連線代表要儲存所擷取資料的目的地連線。要建立目標連接，必須提供與 Data Lake. 此ID為： c604ff05-7f1a-43c0-8e18-33bf874cb11c.

您現在擁有的唯一識別碼是目標架構、目標資料集，以及與 Data Lake. 使用這些識別碼，您可以使用 Flow Service API，指定包含傳入來源資料的資料集。

API格式

POST /targetConnections

要求

下列請求會為 您的來源:

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
    -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 'Content-Type: application/json' \
    -d '{
        "name": "{YOURSOURCE} Target Connection",
        "description": "{YOURSOURCE} Target Connection",
        "connectionSpec": {
            "id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
            "version": "1.0"
        },
        "data": {
            "format": "json"
        },
        "params": {
            "dataSetId": "5ef4551c52e054191a61a99f"
        }
    }'

屬性	說明
`name`	目標連接的名稱。請確定目標連線的名稱是描述性的，因為您可以使用此名稱來查詢目標連線的資訊。
`description`	可包含的選用值，用於提供目標連線的詳細資訊。
`connectionSpec.id`	與 Data Lake. 此固定ID為： `c604ff05-7f1a-43c0-8e18-33bf874cb11c`.
`data.format`	格式您的來源要帶入Platform的資料。
`params.dataSetId`	上一步驟中擷取的目標資料集ID。

回應

成功的回應會傳回新目標連線的唯一識別碼(id)。後續步驟需要此ID。

{
     "id": "7c96c827-3ffd-460c-a573-e9558f72f263",
     "etag": "\"a196f685-f5e8-4c4c-bfbd-136141bb0c6d\""
}

建立對應

若要將來源資料內嵌至目標資料集，必須先將其對應至目標資料集所遵守的目標架構。這是透過執行POST要求來達成 Data Prep API 在要求裝載中定義的資料對應。

API格式

POST /conversion/mappingSets

要求

curl -X POST \
    'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
    -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 'Content-Type: application/json' \
    -d '{
        "version": 0,
        "xdmSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/995dabbea86d58e346ff91bd8aa741a9f36f29b1019138d4",
        "xdmVersion": "1.0",
        "id": null,
        "mappings": [
            {
                "destinationXdmPath": "_id",
                "sourceAttribute": "Id",
                "identity": false,
                "identityGroup": null,
                "namespaceCode": null,
                "version": 0
            },
            {
                "destinationXdmPath": "person.name.firstName",
                "sourceAttribute": "FirstName",
                "identity": false,
                "identityGroup": null,
                "namespaceCode": null,
                "version": 0
            },
            {
                "destinationXdmPath": "person.name.lastName",
                "sourceAttribute": "LastName",
                "identity": false,
                "identityGroup": null,
                "namespaceCode": null,
                "version": 0
            }
        ]
    }'

屬性	說明
`xdmSchema`	的ID target XDM結構在先前的步驟中產生。
`mappings.destinationXdmPath`	要映射源屬性的目標XDM路徑。
`mappings.sourceAttribute`	需要對應至目標XDM路徑的來源屬性。
`mappings.identity`	一個布林值，用於指定是否要為標籤映射集 Identity Service.

回應

成功的回應會傳回新建立之對應的詳細資訊，包括其唯一識別碼(id)。在以後的步驟中需要此值才能建立資料流。

{
    "id": "bf5286a9c1ad4266baca76ba3adc9366",
    "version": 0,
    "createdDate": 1597784069368,
    "modifiedDate": 1597784069368,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}"
}

建立流程

將資料從 您的來源 到平台是建立資料流。您現在已準備下列必要值：

源連接ID
Target連線ID
對應ID

資料流負責從源中調度和收集資料。您可以在裝載中提供先前提及的值時，執行POST要求來建立資料流。

若要排程擷取，您必須先將開始時間值設為紀元時間（以秒為單位）。然後，您必須將頻率值設定為以下五個選項之一： once, minute, hour, day，或 week. 間隔值會指定兩個連續擷取之間的期間，但建立一次性擷取不需要設定間隔。對於所有其他頻率，間隔值必須設定為等於或大於 15.

API格式

POST /flows

要求

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "{YOURSOURCE} dataflow",
        "description": "{YOURSOURCE} dataflow",
        "flowSpec": {
            "id": "6499120c-0b15-42dc-936e-847ea3c24d72",
            "version": "1.0"
        },
        "sourceConnectionIds": [
            "246d052c-da4a-494a-937f-a0d17b1c6cf5"
        ],
        "targetConnectionIds": [
            "7c96c827-3ffd-460c-a573-e9558f72f263"
        ],
        "transformations": [
            {
                "name": "Mapping",
                "params": {
                    "mappingId": "bf5286a9c1ad4266baca76ba3adc9366",
                    "mappingVersion": "0"
                }
            }
        ],
        "scheduleParams": {
            "startTime": "1625040887",
            "frequency": "minute",
            "interval": 15
        }
    }'

屬性	說明
`name`	資料流的名稱。請確保資料流的名稱具有描述性，因為您可以使用此名稱查找資料流的資訊。
`description`	一個可選值，可以包括該值以提供有關資料流的詳細資訊。
`flowSpec.id`	建立資料流所需的流規範ID。此固定ID為： `6499120c-0b15-42dc-936e-847ea3c24d72`.
`flowSpec.version`	流規範ID的相應版本。此值預設為 `1.0`.
`sourceConnectionIds`	此源連接ID 在先前的步驟中產生。
`targetConnectionIds`	此目標連線ID 在先前的步驟中產生。
`transformations`	此屬性包含需要套用至資料的各種轉換。將不符合XDM的資料帶入Platform時，此屬性為必要屬性。
`transformations.name`	指派給轉換的名稱。
`transformations.params.mappingId`	此對應ID 在先前的步驟中產生。
`transformations.params.mappingVersion`	對應ID的對應版本。此值預設為 `0`.
`scheduleParams.startTime`	此屬性包含有關資料流獲取調度的資訊。
`scheduleParams.frequency`	資料流收集資料的頻率。可接受的值包括： `once`, `minute`, `hour`, `day`，或 `week`.
`scheduleParams.interval`	該間隔指定兩個連續流運行之間的週期。間隔的值應為非零整數。頻率設為時不需要間隔 `once` 且應大於或等於 `15` 的其他頻率值。

回應

成功的回應會傳回ID(id)。您可以使用此ID監視、更新或刪除資料流。

{
     "id": "993f908f-3342-4d9c-9f3c-5aa9a189ca1a",
     "etag": "\"510bb1d4-8453-4034-b991-ab942e11dd8a\""
}

附錄

以下部分提供了可以監視、更新和刪除資料流的步驟資訊。

監視資料流

建立資料流後，您可以監視正在通過資料流進行內嵌的資料，以查看有關流運行、完成狀態和錯誤的資訊。如需完整的API範例，請參閱使用API監控來源資料流.

更新資料流

通過向發出PATCH請求，更新資料流的詳細資訊（如其名稱和說明），以及其運行計畫和關聯的映射集 /flows 端點 Flow Service API，同時提供資料流的ID。發出PATCH請求時，必須提供資料流的唯一 etag 在 If-Match 頁首。如需完整的API範例，請參閱使用API更新源資料流

更新您的帳戶

通過向執行PATCH請求，更新源帳戶的名稱、說明和憑據 Flow Service API，同時將基本連線ID設為查詢參數。提出PATCH請求時，您必須提供來源帳戶的唯一 etag 在 If-Match 頁首。如需完整的API範例，請參閱使用API更新您的來源帳戶.

刪除資料流

通過執行DELETE請求以刪除資料流 Flow Service API，同時提供您要在查詢參數中刪除之資料流的ID。如需完整的API範例，請參閱使用API刪除資料流.

刪除您的帳戶

對執行DELETE請求以刪除帳戶 Flow Service API，同時提供您要刪除之帳戶的基本連線ID。如需完整的API範例，請參閱使用API刪除您的來源帳戶.

建立您的來源使用 Flow Service API

總覽

先決條件

收集所需憑據

Connect 您的來源到使用 Flow Service API

建立基本連接

探索源

建立源連接

建立目標XDM結構

建立目標資料集

建立目標連線

建立對應

建立流程

附錄

監視資料流

更新資料流

更新您的帳戶

刪除資料流

刪除您的帳戶

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

說明文件

社群

技術支援

資源

Adobe 帳戶

Adobe

建立 您的來源 使用 Flow Service API

總覽

先決條件

收集所需憑據

Connect 您的來源 到使用 Flow Service API

建立基本連接

探索源

建立源連接

建立目標XDM結構

建立目標資料集

建立目標連線

建立對應

建立流程

附錄

監視資料流

更新資料流

更新您的帳戶

刪除資料流

刪除您的帳戶

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

說明文件

社群

技術支援

資源

Adobe 帳戶

Adobe

建立您的來源使用 Flow Service API

Connect 您的來源到使用 Flow Service API