基礎連線代表來源和Adobe Experience Platform之間已驗證的連線。
本教學課程將逐步引導您完成建立基礎連線的步驟。 Amazon S3 (以下稱"S3")使用 Flow Service API.
本指南需要您實際瞭解下列Adobe Experience Platform元件:
以下小節提供成功連線至所需的其他資訊 S3 使用 Flow Service API。
為了 Flow Service 以連線您的 S3 儲存,您必須提供下列連線屬性的值:
認證 | 說明 |
---|---|
s3AccessKey |
您的存取金鑰ID S3 貯體。 |
s3SecretKey |
您的機密金鑰ID S3 貯體。 |
serviceUrl |
(選用)自訂 S3 要連線的端點。 當您的電子郵件或電子郵件通知 S3 值區是區域專屬的。 的格式 serviceUrl 為: https://s3.{REGION}.amazonaws.com/) . |
bucketName |
此 S3 貯體包含您的資料及其對應的描述性中繼資料。 您的 S3 貯體名稱的長度必須介於3到63個字元之間,且開頭和結尾必須是字母或數字。 貯體名稱只能包含小寫字母、數字或連字型大小(- ),且無法格式化為IP位址。 |
folderPath |
您的檔案夾的路徑 S3 儲存您的資料儲存貯體。 當使用者擁有受限存取權時,需要此認證。 |
s3SessionToken |
(選用)短期的暫時Token,可讓您暫時存取 S3 資源提供給不受信任環境中的使用者。 請參閱 S3 概觀 以取得詳細資訊。 |
connectionSpec.id |
連線規格會傳回來源的聯結器屬性,包括與建立基礎連線和來源連線相關的驗證規格。 的連線規格ID S3 為: ecadc60c-7455-4d87-84dc-2a0e293d997b . |
如需開始使用的詳細資訊,請造訪 此 Amazon Web Services 檔案.
如需如何成功呼叫Platform API的詳細資訊,請參閱以下指南中的 Platform API快速入門.
基礎連線會保留您的來源和平台之間的資訊,包括來源的驗證認證、連線的目前狀態,以及您唯一的基本連線ID。 基本連線ID可讓您瀏覽和瀏覽來源內的檔案,並識別您要擷取的特定專案,包括其資料型別和格式的資訊。
POST若要建立基本連線ID,請向 /connections
端點,同時提供 S3 要求引數中的驗證認證。
API格式
POST /connections
要求
下列要求會建立 S3:
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": "Amazon S3 base connection",
"description": "Amazon S3 base connection with temporary session token",
"auth": {
"specName": "Access Key",
"params": {
"s3AccessKey": "{S3_ACCESS_KEY}",
"s3SecretKey": "{S3_SECRET_KEY}",
"s3SessionToken": "{S3_SESSION_TOKEN}
}
},
"connectionSpec": {
"id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
"version": "1.0"
}
}'
屬性 | 說明 |
---|---|
auth.params.s3AccessKey |
與您的關聯的存取金鑰 S3 貯體。 |
auth.params.s3SecretKey |
與您的關聯之秘密金鑰 S3 貯體。 |
auth.params.s3SessionToken |
(選用)短期、暫時 S3 用於存取貯體的權杖。 |
connectionSpec.id |
此 S3 連線規格ID: ecadc60c-7455-4d87-84dc-2a0e293d997b |
回應
成功回應會傳回新建立連線的詳細資料,包括其唯一識別碼(id
)。 在下一個教學課程中探索您的儲存空間時,需要此ID。
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}
依照本教學課程所述,您已使用API建立S3連線,且已取得唯一ID作為回應內文的一部分。 您可以使用此連線ID來 使用流量服務API探索雲端儲存空間.
下節提供有關使用的其他資訊 S3 來源。
此 s3SessionToken
是暫時性的,並且必須在到期時更新。 您可以透過向發出PATCH請求來更新與您的基本連線關聯的工作階段權杖 Flow Service API。 請參閱 S3 概觀 有關以下專案的臨時安全性憑證的詳細資訊: S3.
此 If-Match
發出PATCH請求時需要標頭。 此標頭的值是您要更新之連線的唯一標籤。
API格式
PATCH /connections
要求
下列要求會建立 S3:
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/connections/4cb0c374-d3bb-4557-b139-5712880adc55' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'If-Match: "1700d77b-0000-0200-0000-5e3b41a10000"'
-d '[
{
"op": "replace",
"path": "/auth/params/s3SessionToken",
"value": "{SESSION_TOKEN}"
}
]'
參數 | 說明 |
---|---|
op |
用來定義更新連線所需動作的操作呼叫。 作業包括: add , replace 、和 remove . |
path |
要更新的引數路徑。 |
value |
您想要用來更新引數的新值。 |
回應
成功的回應會傳回您的基本連線ID和更新的etag。 您可以向發出GET要求以驗證更新 Flow Service API,同時提供您的連線ID。
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}