使用流服務API建立Amazon Kinesis連接器

注意

Amazon Kineses介面處於測試狀態。 有關使用beta標籤連接器的詳細資訊，請參閱來源概觀。

Flow Service 用於收集和集中Adobe Experience Platform內不同來源的客戶資料。該服務提供用戶介面和REST風格的API，所有支援的源都可從中連接。

本教學課程使用Flow Service API來引導您完成將Experience Platform連接至Amazon Kinesis帳戶的步驟。

快速入門

本指南需要有效瞭解Adobe Experience Platform的下列元件：

  • 來源: Experience Platform 允許從各種來源接收資料，同時提供使用服務構建、標籤和增強傳入資料的 Platform 能力。
  • 沙盒: Experience Platform 提供虛擬沙盒，可將單一執行個體分 Platform 割為不同的虛擬環境，以協助開發和發展數位體驗應用程式。

以下各節提供您必須知道的其他資訊，以便使用Flow Service API成功連線至Amazon Kinesis帳戶。

收集必要的認證

要使Flow Service與Amazon Kinesis帳戶連接，您必須為以下連接屬性提供值：

憑證 說明
accessKeyId Kinesis帳戶的存取金鑰ID。
secretKey Kinesis帳戶的機密存取金鑰。
region Kinesis帳戶的地區。
connectionSpec.id Kinesis連接規範ID:86043421-563b-46ec-8e6c-e23184711bf6

有關這些值的詳細資訊，請參閱此Kinesis文檔。

讀取範例API呼叫

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

收集必要標題的值

若要呼叫Platform API，您必須先完成驗證教學課程。 完成驗證教學課程後，所有Experience Platform API呼叫中每個所需標題的值都會顯示在下面：

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有資源（包括屬於Flow Service的資源）都與特定虛擬沙盒隔離。 對Platform API的所有請求都需要一個標題，該標題指定要在中執行操作的沙盒的名稱：

  • x-sandbox-name: {SANDBOX_NAME}

所有包含裝載(POST、PUT、PATCH)的請求都需要額外的媒體類型標題：

  • Content-Type: application/json

建立連線

連接指定源，並包含該源的憑據。 每個Amazon Kinesis帳戶只需要一個連接，因為它可用於建立多個源連接器以導入不同的資料。

API格式

POST /connections

請求

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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Amazon Kinesis connection",
        "description": "Connector for Amazon Kinesis",
        "auth": {
            "specName": "Basic Authentication for Kinesis",
            "params": {
                "accessKeyId": "accessKeyId",
                "secretKey": "secretKey"
            }
        },
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        }
    }'
屬性 說明
auth.params.accessKeyId Kinesis帳戶的存取金鑰ID。
auth.params.secretKey Kinesis帳戶的機密存取金鑰。
auth.params.region Kinesis帳戶的地區。
connectionSpec.id Kinesis連接規範ID:86043421-563b-46ec-8e6c-e23184711bf6

回應

成功的響應返回新建立的連接的詳細資訊，包括其唯一標識符(id)。 在下一個教學課程中，探索您的雲端儲存空間資料時，需要此ID。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

後續步驟

在本教學課程中，您已使用API建立Amazon Kinesis連線，並取得唯一ID做為回應內文的一部分。 您可以使用此連線ID來使用Flow Service API收集串流資料。

本頁內容