建立 Amazon 使用的S3基本連線 Flow Service API

基本連線代表來源和Adobe Experience Platform之間已驗證的連線。

本教學課程會逐步引導您完成建立基礎連線的步驟 Amazon S3 (下稱「S3")使用 Flow Service API.

快速入門

本指南需要妥善了解下列Adobe Experience Platform元件：

  • 來源: Experience Platform 可讓您從各種來源擷取資料，同時使用來建構、加標籤及增強傳入資料 Platform 服務。
  • 沙箱: Experience Platform 提供可分割單一沙箱的虛擬沙箱 Platform 例項放入個別的虛擬環境，以協助開發及改進數位體驗應用程式。

以下小節提供您需要知道的其他資訊，以便成功連接到 S3 儲存 Flow Service API。

收集所需憑據

為了 Flow Service 與 S3 儲存，您必須提供下列連線屬性的值：

憑據 說明
s3AccessKey 您 S3 桶。
s3SecretKey 您 S3 桶。
serviceUrl （選用）自訂 S3 端點連接到。 若您的 S3 貯體是特定區域。 的格式 serviceUrl 為： https://s3.{REGION}.amazonaws.com/).
bucketName 此 S3 貯體包含您的資料及其對應的描述性中繼資料。 您的 S3 貯體名稱的長度必須介於3到63個字元之間，且必須以字母或數字開頭和結尾。 貯體名稱只能有小寫字母、數字或連字型大小(-)，且無法格式化為IP位址。
folderPath 您的 S3 儲存資料的貯體。 當用戶具有受限訪問權限時，此憑據是必需的。
s3SessionToken （選用）短期的暫時代號，可讓您提供對 S3 資源給不受信任環境中的用戶。 請參閱 S3 概述 以取得更多資訊。
connectionSpec.id 連接規範返回源的連接器屬性，包括與建立基連接和源連接相關的驗證規範。 的連接規範ID S3 為： ecadc60c-7455-4d87-84dc-2a0e293d997b.

如需快速入門的詳細資訊，請造訪 此 Amazon Web Services 檔案.

使用平台API

如需如何成功呼叫Platform API的詳細資訊，請參閱 Platform API快速入門.

建立基本連接

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

若要建立基本連線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 來源。

更新您的 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。 您可以向 Flow Service API，同時提供您的連線ID。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

本頁內容