使用Flow Service API连接Salesforce以Experience Platform

阅读本指南,了解如何使用Flow Service API将您的Salesforce源帐户连接到Adobe Experience Platform。

快速入门

本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:

  • : Experience Platform允许从各种源摄取数据,同时允许您使用Platform服务来构建、标记和增强传入数据。
  • 沙盒: Experience Platform提供将单个Platform实例划分为单独虚拟环境的虚拟沙盒,以帮助开发和改进数字体验应用程序。

使用平台API

有关如何成功调用平台API的信息,请参阅平台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源实例的URL。 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的连接规范ID为: 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源实例的URL。 environmentUrl的格式为https://[domain].my.salesforce.com
clientId 在OAuth2身份验证中,客户端ID与客户端密钥结合使用。 客户端ID和客户端密钥共同使您的应用程序能够代表您的帐户运行,方法是向Salesforce标识您的应用程序。
clientSecret 客户端密钥与客户端ID结合使用,作为OAuth2身份验证的一部分。 客户端ID和客户端密钥共同使您的应用程序能够代表您的帐户运行,方法是向Salesforce标识您的应用程序。
apiVersion 您正在使用的Salesforce实例的REST API版本。 API版本的值必须使用小数格式设置。 例如,如果您使用的是API版本52,则必须以52.0的形式输入值。 如果此字段留空,则Experience Platform将自动使用最新可用版本。 此值对于OAuth2客户端凭据身份验证是必需的。
connectionSpec.id 连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 Salesforce的连接规范ID为: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5

有关为Salesforce使用OAuth的更多信息,请阅读有关OAuth授权流程🔗的Salesforce 指南。

在Azure的Experience Platform中为Salesforce创建基本连接

基本连接会保留您的源和平台之间的信息,包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。 基本连接ID允许您浏览和浏览源中的文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。

要创建基本连接并将您的Salesforce帐户连接到Azure上的Experience Platform,请向/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连接规范ID: 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连接规范ID: 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帐户连接到AWS上的Experience Platform,请向/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

请求

选择以查看请求

以下请求检索基本连接ID的信息: 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
选择以查看响应示例

以下响应显示处于initializing状态时基本连接ID的信息: 3e908d3f-c390-482b-9f44-43d3d4f2eb82

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
选择以查看响应示例

以下响应显示处于enabled状态时基本连接ID的信息: 3e908d3f-c390-482b-9f44-43d3d4f2eb82

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