使用Flow Service API建立Phoenix基本連線

Last update: Fri Nov 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：

建立對象：

開發人員

WARNING

Phoenix來源將於2025年5月底淘汰。

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

本教學課程提供如何使用Flow Service API建立基本連線並將Phoenix帳戶連線到Adobe Experience Platform的步驟。

快速入門

本指南需要您實際瞭解下列Experience Platform元件：

來源：Experience Platform允許從各種來源擷取資料，同時讓您能夠使用Experience Platform服務來建構、加標籤以及增強傳入的資料。
沙箱：Experience Platform提供的虛擬沙箱可將單一Experience Platform執行個體分割成個別的虛擬環境，以利開發及改進數位體驗應用程式。

下列章節提供您需瞭解的其他資訊，才能使用Flow Service API成功連線到Phoenix。

收集必要的認證

您必須提供下列驗證認證，才能將您的Phoenix帳戶連線到Experience Platform。

認證

說明

host

Phoenix伺服器的IP位址或主機名稱。

username

您用來存取Phoenix伺服器的使用者名稱。

password

與使用者對應的密碼。

port

Phoenix伺服器用來監聽使用者端連線的TCP連線埠。如果您要連線到Azure HDInsights，則指定連線埠為443。如果未提供此引數，則值預設為8765。

httpPath

對應至Phoenix伺服器的部分URL。如果使用Azure HDInsights叢集，請指定/hbasephoenix0。

enableSsl

布林值。指定是否使用SSL加密伺服器連線。

connectionSpec.id

連線規格會傳回來源的聯結器屬性，包括與建立基礎連線和來源連線相關的驗證規格。 Phoenix的連線規格識別碼為： 102706fb-a5cd-42ee-afe0-bc42f017ff43

如需開始使用的詳細資訊，請參閱此Phoenix檔案。

使用平台API

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

建立基礎連線

基礎連線會保留您的來源和平台之間的資訊，包括來源的驗證認證、連線的目前狀態，以及您唯一的基本連線ID。基礎連線ID可讓您從來源內部探索及導覽檔案，並識別您要擷取的特定專案，包括其資料型別和格式的資訊。

若要建立基底連線，請在要求內文中提供您的Phoenix驗證認證時，向/connections端點提出POST要求。

API格式

POST /connections

要求

下列要求會建立Phoenix的基礎連線：

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": "Phoenix test connection",
      "description": "Phoenix test connection",
      "auth": {
          "specName": "Basic Authentication",
      "params": {
          "host":  "{HOST}",
          "username": "{USERNAME}",
          "password":"{PASSWORD}",
          "port": {PORT},
          "httpPath": "{PATH}",
          "enableSsl": {SSL}
          }
      },
      "connectionSpec": {
          "id": "102706fb-a5cd-42ee-afe0-bc42f017ff43",
          "version": "1.0"
      }
  }'

屬性

說明

auth.params.host

Phoenix伺服器的主機。

auth.params.username

與您的Phoenix連線相關聯的使用者名稱。

auth.params.password

與您的Phoenix連線相關聯的密碼。

auth.params.port

您的Phoenix連線的TCP連線埠。

auth.params.httpPath

Phoenix連線的部分http路徑。

auth.params.enableSsl

指定是否使用SSL加密伺服器連線的布林值。

connectionSpec.id

Phoenix連線規格識別碼： 102706fb-a5cd-42ee-afe0-bc42f017ff43。

回應

成功的回應會傳回新建立連線的詳細資料，包括其唯一識別碼(id)。在下個教學課程中探索您的資料時，需要此ID。

{
    "id": "0d982fff-c443-403e-982f-ffc443f03e37",
    "etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}

後續步驟

依照此教學課程，您已使用Flow Service API建立Phoenix基礎連線。您可以在下列教學課程中使用此基本連線ID：

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089