使用Flow Service API連線Salesforce以Experience Platform

閱讀本指南,瞭解如何使用Flow Service API將您的Salesforce來源帳戶連結至Adobe Experience Platform。

快速入門

本指南需要您深入了解下列 Adobe Experience Platform 元件:

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

使用平台API

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

連線Salesforce至Azure上的Experience Platform azure

請閱讀下列步驟,以瞭解如何連線您的Salesforce來源以在Azure上Experience Platform。

收集必要的認證

Salesforce來源支援基本驗證和OAuth2使用者端認證。

基本驗證

若要使用基本驗證將您的Salesforce帳戶連線到Flow Service,請提供下列認證的值:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
認證 說明
environmentUrl Salesforce來源執行個體的網址。 environmentUrl的格式為https://[domain].my.salesforce.com
username Salesforce使用者帳戶的使用者名稱。
password Salesforce使用者帳戶的密碼。
securityToken Salesforce使用者帳戶的安全性權杖。
apiVersion 選用性)您正在使用的Salesforce執行個體的REST API版本。 API版本的值必須使用小數點格式化。 例如,如果您使用API版本52,則必須以52.0的形式輸入值。 如果此欄位留空,則Experience Platform將自動使用最新可用版本。
connectionSpec.id 連線規格會傳回來源的聯結器屬性,包括與建立基礎連線和來源連線相關的驗證規格。 Salesforce的連線規格識別碼為: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5

如需開始使用的詳細資訊,請瀏覽此Salesforce檔案

OAuth 2使用者端認證

若要使用OAuth 2使用者端認證將您的Salesforce帳戶連線至Flow Service,請提供下列認證的值:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
認證 說明
environmentUrl Salesforce來源執行個體的網址。 environmentUrl的格式為https://[domain].my.salesforce.com
clientId 使用者端ID會與使用者端密碼搭配使用,作為OAuth2驗證的一部分。 使用者端ID和使用者端密碼可讓您的應用程式透過向Salesforce識別您的應用程式,以代表您的帳戶運作。
clientSecret 使用者端密碼會與使用者端ID搭配使用,做為OAuth2驗證的一部分。 使用者端ID和使用者端密碼可讓您的應用程式透過向Salesforce識別您的應用程式,以代表您的帳戶運作。
apiVersion 您正在使用的Salesforce執行個體的REST API版本。 API版本的值必須使用小數點格式化。 例如,如果您使用API版本52,則必須以52.0的形式輸入值。 如果此欄位留空,則Experience Platform將自動使用最新可用版本。 此值是OAuth2使用者端認證驗證的必要專案。
connectionSpec.id 連線規格會傳回來源的聯結器屬性,包括與建立基礎連線和來源連線相關的驗證規格。 Salesforce的連線規格識別碼為: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5

如需針對Salesforce使用OAuth的詳細資訊,請參閱OAuth授權流程🔗的Salesforce 指南。

在Azure的Experience Platform中為Salesforce建立基底連線

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

若要建立基底連線並連線您的Salesforce帳戶以Experience Platform於Azure,請向/connections端點發出POST要求,並在要求內文中提供您的Salesforce驗證認證。

API格式

POST /connections
基本驗證
accordion
要求

下列要求使用基本驗證建立Salesforce的基本連線:

code language-shell
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": "ACME Salesforce account",
      "description": "Salesforce account using basic authentication",
      "auth": {
          "specName": "Basic Authentication",
          "params":
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "username": "acme-salesforce",
            "password": "xxxx",
            "securityToken": "xxxx"
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
屬性 說明
auth.params.environmentUrl Salesforce執行個體的URL。
auth.params.username 與您的Salesforce帳戶相關聯的使用者名稱。
auth.params.password 與您的Salesforce帳戶關聯的密碼。
auth.params.securityToken 與您的Salesforce帳戶關聯的安全性權杖。
connectionSpec.id Salesforce連線規格識別碼: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5
accordion
回應

成功的回應會傳回您新建立的基本連線及其唯一ID。

code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}
OAuth 2使用者端認證
accordion
要求

以下要求使用OAuth 2使用者端認證為Salesforce建立基礎連線:

code language-shell
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": "ACME Salesforce account",
      "description": "Salesforce account using OAuth 2",
      "auth": {
          "specName": "OAuth2 Client Credential",
          "params":
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "clientId": "xxxx",
            "clientSecret": "xxxx",
            "apiVersion": "60.0"
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
屬性 說明
auth.params.environmentUrl Salesforce執行個體的URL。
auth.params.clientId 與您的Salesforce帳戶相關聯的使用者端ID。
auth.params.clientSecret 與您的Salesforce帳戶相關聯的使用者端密碼。
auth.params.apiVersion 您正在使用的Salesforce執行個體的REST API版本。
connectionSpec.id Salesforce連線規格識別碼: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5
accordion
回應

成功的回應會傳回您新建立的基本連線及其唯一ID。

code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}

連線Salesforce以在Amazon Web Services (AWS)上Experience Platform aws

AVAILABILITY
本節適用於在Amazon Web Services (AWS)上執行的Experience Platform實作。 在AWS上執行的Experience Platform目前可供有限數量的客戶使用。 若要深入瞭解支援的Experience Platform基礎結構,請參閱Experience Platform多雲端總覽

請閱讀下列步驟,以瞭解如何連線您的Salesforce來源以在AWS上Experience Platform。

先決條件

如需有關如何設定您的Salesforce帳戶以便在AWS上連線到Experience Platform的資訊,請閱讀Salesforce 總覽

在AWS上Experience Platform為Salesforce建立基礎連線

若要建立基礎連線並連線您的Salesforce帳戶以Experience Platform在AWS上,請向/connections端點發出POST請求並提供您認證的適當值。

API格式

POST /connections

要求

選取以檢視請求

下列要求會為AWS上的Experience Platform中的Salesforce來源建立基底連線。

code language-shell
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 'Content-Type: application/json' \
  -d '{
      "name": "ACME Salesforce account on AWS",
      "description": "ACME Salesforce account on AWS",
      "auth": {
          "specName": "OAuth2 JWT Token Credential",
          "params":
            "jwtToken": "{JWT_TOKEN},
            "clientId": "xxxx",
            "clientSecret": "xxxx",
            "instanceUrl": "https://acme-enterprise-3126.my.salesforce.com"
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'

如需如何擷取您的Salesforce jwtToken的詳細資訊,請閱讀上的指南如何設定 Salesforce 來源以連線到AWS上的Experience Platform。

回應

選取以檢視回應

成功的回應會傳回您新建立的基本連線及其唯一ID。

code language-json
{
    "id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
    "etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}

驗證您的連線狀態

若要驗證您的連線狀態,請向/connections端點發出GET要求,並提供在建立步驟中產生的基本連線ID。

API格式

GET /connections

要求

選取以檢視請求

下列要求會擷取基底連線識別碼的資訊: 3e908d3f-c390-482b-9f44-43d3d4f2eb82

code language-shell
curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/3e908d3f-c390-482b-9f44-43d3d4f2eb82' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \

回應

正在初始化
accordion
選取以檢視回應範例

下列回應顯示基底連線識別碼的資訊: 3e908d3f-c390-482b-9f44-43d3d4f2eb82 (處於initializing狀態)。

code language-json
{
  "items": [
    {
      "id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
      "createdAt": 1736506325115,
      "updatedAt": 1736506325717,
      "createdBy": "acme@techacct.adobe.com",
      "updatedBy": "acme@techacct.adobe.com",
      "createdClient": "{CREATED_CLIENT}",
      "updatedClient": "{UPDATED_CLIENT}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "{SANDBOX_NAME}",
      "imsOrgId": "{ORG_ID}",
      "name": "JWT Token Auth Authentication E2E-1736506322",
      "description": "Base Connection for salesforce E2E",
      "connectionSpec": {
        "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
        "version": "1.0"
      },
      "state": "initializing",
      "auth": {
        "specName": "OAuth2 JWT Token Credential",
        "params": {
          "jwtToken": "{JWT_TOKEN}",
          "clientId": "{CLIENT_ID}",
          "clientSecret": "{CLIENT_SECRET}",
          "instanceUrl": "https://acme-enterprise-3126.my.salesforce.com"
        }
      }
    }
  }
]
已啟用
accordion
選取以檢視回應範例

下列回應顯示基底連線識別碼的資訊: 3e908d3f-c390-482b-9f44-43d3d4f2eb82 (處於enabled狀態)。

code language-json
{
  "items": [
      {
        "id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
        "createdAt": 1736506325115,
        "updatedAt": 1736506413299,
        "createdBy": "acme@techacct.adobe.com",
        "updatedBy": "acme@AdobeID",
        "createdClient": "{CREATED_CLIENT}",
        "updatedClient": "acme",
        "sandboxId": "{SANDBOX_ID}",
        "sandboxName": "{SANDBOX_NAME}",
        "imsOrgId": "{ORG_ID}",
        "name": "JWT Token Auth Authentication E2E-1736506322",
        "description": "Base Connection for salesforce E2E",
        "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
        },
        "state": "enabled",
        "auth": {
          "specName": "OAuth2 JWT Token Credential",
          "params": {
            "jwtToken": "{JWT_TOKEN}",
            "clientId": "{CLIENT_ID}",
            "clientSecret": "{CLIENT_SECRET}",
            "instanceUrl": "https://adb8-dev-ed.develop.my.salesforce.com",
            "orgId": "00DdL000001iPRxUAM"
          }
        },
        "version": "\"6d27f305-40be-41c3-97d4-a701827c34df\"",
        "etag": "\"6d27f305-40be-41c3-97d4-a701827c34df\""
    }
  ]
}

後續步驟

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

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089