[Beta]{class="badge informative"}
使用Flow Service API為SAP Commerce建立來源連線和資料流
下列教學課程將逐步引導您建立SAP Commerce來源連線和資料流,以使用Flow Service API將SAP 訂閱帳單連絡人和客戶資料匯入Adobe Experience Platform。
快速入門
本指南需要您實際瞭解下列Experience Platform元件:
下列章節提供您需瞭解的其他資訊,才能使用Flow Service API成功連線到SAP Commerce。
收集必要的認證
為了將SAP Commerce連線到Experience Platform,您必須提供下列連線屬性的值:
clientId
clientId
值。clientSecret
clientSecret
值。tokenEndpoint
url
值,會類似https://subscriptionbilling.authentication.eu10.hana.ondemand.com
。region
url
中,其值類似於eu10
或us10
。 例如,如果url
是https://subscriptionbilling.authentication.eu10.hana.ondemand.com
,則您需要eu10
。如需這些認證的詳細資訊,請參閱SAP Commerce 檔案。
使用Flow Service API連線SAP Commerce至平台
以下概述驗證SAP Commerce來源、建立來源連線,以及建立資料流以將您的帳戶和連絡人資料帶到Experience Platform所需的步驟。
建立基礎連線 base-connection
基礎連線會保留您的來源和平台之間的資訊,包括來源的驗證認證、連線的目前狀態,以及您唯一的基本連線ID。 基礎連線ID可讓您從來源內部探索及導覽檔案,並識別您要擷取的特定專案,包括其資料型別和格式的資訊。
若要建立基底連線ID,請在提供您的SAP Commerce驗證認證作為要求內文的一部分時,向/connections
端點提出POST要求。
API格式
POST /connections
要求
下列要求會建立SAP Commerce的基礎連線:
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": "SAP Commerce base connection",
"description": "Authenticated base connection for SAP Commerce",
"connectionSpec": {
"id": "d8ee38de-7ae9-4058-9610-c79ce75f8e92",
"version": "1.0"
},
"auth": {
"specName": "OAuth2 Client Credential",
"params": {
"region": "{REGION}",
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}"
"tokenEndpoint": "{TOKEN_ENDPOINT}"
}
}
}'
name
description
connectionSpec.id
auth.specName
auth.params.region
url
中,其值類似於eu10
或us10
。 例如,如果url
是https://subscriptionbilling.authentication.eu10.hana.ondemand.com
,您需要eu10
。auth.params.clientId
clientId
值。auth.params.clientSecret
clientSecret
值。auth.params.tokenEndpoint
url
值,會類似https://subscriptionbilling.authentication.eu10.hana.ondemand.com
。回應
成功的回應會傳回新建立的基礎連線,包括其唯一的連線識別碼(id
)。 在下一步中探索來源的檔案結構和內容時,需要此ID。
{
"id": "5f6d6022-3f64-400c-ba01-d4010de2d8ff",
"etag": "\"f8018de1-0000-0200-0000-6482d7210000\""
}
探索您的來源 explore
取得基礎連線ID後,您現在可以透過對/connections
端點執行GET要求,同時提供基礎連線ID作為查詢引數,以探索來源資料的內容和結構。
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}
執行GET請求以探索來源的檔案結構和內容時,您必須包括下表列出的查詢引數:
{BASE_CONNECTION_ID}
objectType=rest
rest
。{OBJECT}
json
。fileType=json
json
是唯一受支援的檔案型別。{PREVIEW}
{SOURCE_PARAMS}
定義您要帶到Platform之來源檔案的引數。 若要擷取{SOURCE_PARAMS}
接受的格式型別,您必須以base64編碼整個字串。
SAP Commerce支援多個API。 根據您使用的物件型別,傳遞下列其中一項:
customers
contacts
SAP Commerce來源支援多個API。 根據您運用要傳送的請求的物件型別,如下所示:
accordion | ||
---|---|---|
要求 | ||
針對SAP Commerce客戶API,
|
accordion | ||
---|---|---|
回應 | ||
成功的回應會傳回JSON結構,如下所示:
|
accordion | ||
---|---|---|
要求 | ||
針對SAP Commerce Contacts API,
|
accordion | ||
---|---|---|
回應 | ||
成功的回應會傳回JSON結構,如下所示:
|
建立來源連線 source-connection
您可以向Flow Service API的/sourceConnections
端點發出POST要求,以建立來源連線。 來源連線由連線ID、來源資料檔案的路徑以及連線規格ID組成。
API格式
POST /sourceConnections
根據您使用的物件型別,從下列標籤中選取:
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
要求 | ||||||||||||||||||||
下列要求會建立SAP Commerce客戶資料的來源連線:
|
accordion | ||
---|---|---|
回應 | ||
成功的回應會傳回新建立的來源連線的唯一識別碼(
|
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
要求 | ||||||||||||||||||||
下列要求會建立SAP Commerce連絡人資料的來源連線:
|
accordion | ||
---|---|---|
回應 | ||
成功的回應會傳回新建立的來源連線的唯一識別碼(
|
建立目標XDM結構描述 target-schema
為了在Platform中使用來源資料,必須建立目標結構描述,以根據您的需求來建構來源資料。 然後目標結構描述會用來建立包含來源資料的Platform資料集。
可透過對結構描述登入API執行POST要求來建立目標XDM結構描述。
如需有關如何建立目標XDM結構描述的詳細步驟,請參閱有關使用API 建立結構描述的教學課程。
建立目標資料集 target-dataset
可以透過對目錄服務API執行POST要求,在承載中提供目標結構描述的ID來建立目標資料集。
如需有關如何建立目標資料集的詳細步驟,請參閱有關使用API建立資料集的教學課程。
建立目標連線 target-connection
目標連線代表與要儲存所擷取資料的目的地之間的連線。 若要建立目標連線,您必須提供對應至資料湖的固定連線規格ID。 此ID為: c604ff05-7f1a-43c0-8e18-33bf874cb11c
。
您現在具有目標結構描述、目標資料集和到資料湖的連線規格ID的唯一識別碼。 使用這些識別碼,您可以使用Flow Service API建立目標連線,以指定將包含傳入來源資料的資料集。
API格式
POST /targetConnections
要求
下列要求會建立SAP Commerce的目標連線:
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": "SAP Commerce Target Connection Generic Rest",
"description": "SAP Commerce Target Connection Generic Rest",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "parquet_xdm",
"schema": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/325fd5394ba421246b05c0a3c2cd5efeec2131058a63d473",
"version": "1.2"
}
},
"params": {
"dataSetId": "645923cd7aeeea1c06c5e92e"
}
}'
name
description
connectionSpec.id
6b137bf6-d2a0-48c8-914b-d50f4942eb85
。data.format
params.dataSetId
回應
成功的回應會傳回新目標連線的唯一識別碼(id
)。 此ID在後續步驟中是必要的。
{
"id": "5b72a4b6-2fb8-4ca7-8ad8-4114a3063c5c",
"etag": "\"db00c6dc-0000-0200-0000-6482d8280000\""
}
建立對應 mapping
為了將來源資料擷取到目標資料集中,必須首先將其對應到目標資料集所堅持的目標結構描述。 這是透過透過使用在要求裝載中定義的資料對應對Data Prep API執行POST要求來達成。
API格式
POST /conversion/mappingSets
accordion | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
要求 | ||||||||||||||
下列請求會建立SAP Commerce客戶API資料的對應
|
accordion | ||
---|---|---|
回應 | ||
成功的回應會傳回新建立的對應詳細資料,包括其唯一識別碼(
|
accordion | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
要求 | ||||||||||||||
下列要求會建立SAP Commerce連絡人API資料的對應
|
accordion | ||
---|---|---|
回應 | ||
成功的回應會傳回新建立的對應詳細資料,包括其唯一識別碼(
|
建立流程 flow
將資料從SAP Commerce引進Platform的最後一步是建立資料流。 到現在為止,您已準備下列必要值:
資料流負責從來源排程及收集資料。 您可以執行POST要求,同時在裝載中提供先前提到的值,藉此建立資料流。
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": "SAP Commerce Connector Description Flow Generic Rest",
"description": "SAP Commerce Connector Description Flow Generic Rest",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"2ef2e831-f4f1-4363-a0f7-08b4ea347164"
],
"targetConnectionIds": [
"5b72a4b6-2fb8-4ca7-8ad8-4114a3063c5c"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "ddf0592bcc9d4ac391803f15f2429f87",
"mappingVersion": "0"
}
}
],
"scheduleParams": {
"startTime": "1625040887",
"frequency": "once",
}
}'
name
description
flowSpec.id
6499120c-0b15-42dc-936e-847ea3c24d72
。flowSpec.version
1.0
。sourceConnectionIds
targetConnectionIds
transformations
transformations.name
transformations.params.mappingId
transformations.params.mappingVersion
0
。scheduleParams.startTime
scheduleParams.frequency
scheduleParams.interval
回應
成功的回應會傳回新建立的資料流識別碼(id
)。 您可以使用此ID來監視、更新或刪除資料流。
{
"id": "fcd16140-81b4-422a-8f9a-eaa92796c4f4",
"etag": "\"9200a171-0000-0200-0000-6368c1da0000\""
}
附錄
下節提供監視、更新和刪除資料流的步驟相關資訊。
監視資料流
建立資料流後,您可以監視透過該資料流擷取的資料,以檢視有關資料流執行、完成狀態和錯誤的資訊。 如需完整的API範例,請閱讀使用API監視您的來源資料流的指南。
更新您的資料流
提供資料流的ID時,藉由向Flow Service API的/flows
端點發出PATCH要求,更新資料流的詳細資訊,例如其名稱和說明,以及其執行排程和相關聯的對應集。 提出PATCH要求時,您必須在If-Match
標頭中提供資料流的唯一etag
。 如需完整的API範例,請閱讀使用API更新來源資料流的指南。
更新您的帳戶
在提供您的基本連線ID作為查詢引數的同時,透過對Flow Service API執行PATCH請求來更新來源帳戶的名稱、說明和認證。 發出PATCH要求時,您必須在If-Match
標頭中提供來源帳戶的唯一etag
。 如需完整的API範例,請閱讀使用API更新來源帳戶的指南。
刪除您的資料流
提供您要刪除之資料流的ID做為查詢引數的一部分,同時對Flow Service API執行DELETE要求,以刪除您的資料流。 如需完整的API範例,請閱讀使用API刪除資料流的指南。
刪除您的帳戶
在提供您要刪除之帳戶的基本連線ID時,透過對Flow Service API執行DELETE要求來刪除帳戶。 如需完整的API範例,請閱讀使用API刪除來源帳戶的指南。