Show Menu
主題×

使用Flow Service API建立Amazon S3連接器

Flow Service用於收集和集中Adobe Experience Platform內不同來源的客戶資料。 該服務提供用戶介面和REST風格的API,所有支援的源都可從中連接。
本教學課程使用Flow Service API來引導您完成將Experience Platform連接至Amazon S3(以下稱為「S3」)儲存空間的步驟。
如果您想要在Experience Platform中使用使用者介面, 在UI中建立Azure Blob或Amazon S3來源連接器 Azure Blob或Amazon S3來源連接器UI教學課程會提供執行類似動作的逐步指示。

快速入門

本指南需要有效瞭解Adobe Experience Platform的下列元件:
  • 來源 :Experience Platform可讓您從各種來源擷取資料,同時讓您能夠使用平台服務來建構、標示和增強傳入資料。
  • 沙盒 :Experience Platform提供虛擬沙盒,可將單一Platform實例分割為不同的虛擬環境,以協助開發和發展數位體驗應用程式。
以下各節提供您需要瞭解的其他資訊,以便使用Flow Service API成功連線至S3儲存空間。

收集必要的認證

為了讓流服務與您的S3儲存連接,您必須為以下連接屬性提供值:
憑證
說明
s3AccessKey
S3儲存空間的存取金鑰ID。
s3SecretKey
S3儲存空間的機密金鑰ID。
有關入門的更多資訊,請 訪問此AWS文檔

讀取範例API呼叫

本教學課程提供範例API呼叫,以示範如何設定請求的格式。 這些包括路徑、必要標題和正確格式化的請求負載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所用慣例的詳細資訊,請參閱「Experience Platform疑難排解指 南」中有關如何讀取範例API呼叫的章節

收集必要標題的值

若要呼叫平台API,您必須先完成驗證教 學課程 。 完成驗證教學課程後,所有Experience Platform API呼叫中每個必要標題的值都會顯示在下方:
  • 授權:生產者 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Experience Platform中的所有資源(包括屬於流服務的資源)都會隔離至特定的虛擬沙盒。 所有對平台API的請求都需要一個標題,該標題會指定要在中執行的操作的沙盒名稱:
  • x-sandbox-name: {SANDBOX_NAME}
所有包含裝載(POST、PUT、PATCH)的請求都需要額外的媒體類型標題:
  • 內容類型: application/json

查找連接規格

在將平台連接到S3儲存器之前,必須驗證S3的連接規範是否存在。 如果連接規範不存在,則無法建立連接。
每個可用源都有其唯一的連接規範集,用於描述連接器屬性(如驗證要求)。 您可以執行GET請求並使用查詢參數來查找S3的連接規範。
API格式
傳送不含查詢參數的GET請求時,會傳回所有可用來源的連線規格。 您可以包含查詢 property=name=="amazon-s3" 以取得S3的特定資訊。
GET /connectionSpecs
GET /connectionSpecs?property=name=="amazon-s3"

請求
以下請求檢索S3的連接規範。
curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="amazon-s3"' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

回應
成功的回應會傳回S3的連線規格,包括其唯一識別碼( id )。 在下個步驟中需要此ID才能建立基本連線。
{
    "items": [
        {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "name": "amazon-s3",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Access Key",
                    "type": "Access Key Auth",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to amazon-s3",
                        "properties": {
                            "s3AccessKey": {
                                "type": "string",
                                "description": "access key id"
                            },
                            "s3SecretKey": {
                                "type": "string",
                                "description": "Secret access key for the user account",
                                "format": "password"
                            }
                        },
                        "required": [
                            "accessKeyId",
                            "secretAccessKey"
                        ]
                    }
                }
            ]
        }
    ]
}

建立基本連接

基本連接指定源,並包含該源的憑據。 每個S3帳戶只需要一個基本連線,因為它可用來建立多個來源連接器,以匯入不同的資料。
API格式
POST /connections

請求
curl -X POST \
    'http://platform.adobe.io/data/foundation/flowservice/connections' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "S3 Base Connection",
        "description": "Base connection for an Amazon S3 account",
        "auth": {
            "specName": "Access Key",
            "params": {
                "s3AccessKey": "{S3_ACCESS_KEY}",
                "s3SecretKey": "{S3_SECRET_KEY}"
            }
        },
        "connectionSpec": {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "version": "1.0"
        }
    }'

屬性
說明
auth.params.s3AccessKey
與您的S3儲存空間關聯的存取金鑰。
auth.params.s3SecretKey
與S3儲存空間關聯的機密金鑰。
connectionSpec.id
在上一步 id 中檢索的S3儲存的連接規範。
回應
成功的響應返回新建立的基本連接的詳細資訊,包括其唯一標識符( id )。 在下一個教學課程中探索您的儲存空間時,需要此ID。
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

後續步驟

在本教學課程中,您已使用API建立S3連線,並且已取得唯一ID作為回應內文的一部分。 您可以使用此連線ID來 探索使用Flow Service API的雲端儲存空間 ,或 使用Flow Service API內嵌鑲木地板資料