建立 Amazon 使用 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 您的訪問密鑰ID S3 桶。
s3SecretKey 您的密鑰ID S3 桶。
serviceUrl (可選)自定義 S3 要連接到的終結點。 當您 S3 桶是特定於區域的。 格式 serviceUrl 為: https://s3.{REGION}.amazonaws.com/)
bucketName 的 S3 bucket包含您的資料及其相應的描述性元資料。 您 S3 儲存段名稱的長度必須介於3到63個字元之間,且必須以字母或數字開頭和結尾。 儲存桶名稱只能包含小寫字母、數字或連字元(-),並且不能格式化為IP地址。
folderPath 資料夾的路徑 S3 儲存資料的儲存桶。 當用戶具有限制訪問時,此憑據是必需的。
s3SessionToken (可選)短期臨時令牌,允許您提供對 S3 資源到不受信任環境中的用戶。 查看 S3 概述 的子菜單。
connectionSpec.id 連接規範返回源的連接器屬性,包括與建立基連接和源連接相關的驗證規範。 連接規範ID S3 為: ecadc60c-7455-4d87-84dc-2a0e293d997b

有關入門的詳細資訊,請訪問 這個 Amazon Web Services 文檔

使用平台API

有關如何成功調用平台API的資訊,請參見上的指南 平台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 用於定義更新連接所需操作的操作調用。 操作包括: addreplace, remove
path 要更新的參數的路徑。
value 要用更新參數的新值。

回應

成功的響應將返回基本連接ID和更新的etag。 您可以通過向Web站點發出GET請求來驗證更新 Flow Service API,同時提供連接ID。

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

本頁內容