创建 Salesforce 基本连接使用 Flow Service API

基本连接表示源和Adobe Experience Platform之间的已验证连接。

本教程将指导您完成创建基本连接的步骤。 Salesforce 使用 Flow Service API.

快速入门

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

  • : Experience Platform 允许从各种源摄取数据,同时让您能够使用以下内容构建、标记和增强传入数据: Platform 服务。
  • 沙盒: Experience Platform 提供对单个文件夹进行分区的虚拟沙盒 Platform 将实例安装到单独的虚拟环境中,以帮助开发和改进数字体验应用程序。

以下部分提供成功连接时需要了解的其他信息 Platform 到 Salesforce 帐户使用 Flow Service API。

收集所需的凭据

此 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 的URL Salesforce 源实例。
username 的用户名 Salesforce 用户帐户。
password 的密码 Salesforce 用户帐户。
securityToken 的安全令牌 Salesforce 用户帐户。
apiVersion 可选) REST API版本的 Salesforce 您正在使用的实例。 API版本的值必须使用小数格式设置。 例如,如果您使用的是API版本 52,则必须输入值,如下所示 52.0. 如果此字段留空,则Experience Platform将自动使用最新可用版本。
connectionSpec.id 连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 的连接规范ID Salesforce 为: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

有关入门的更多信息,请访问 此Salesforce文档.

OAuth 2客户端凭据

连接您的 Salesforce 帐户至 Flow Service 使用OAuth 2客户端凭据,提供以下凭据的值:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
凭据 描述
environmentUrl 的URL Salesforce 源实例。
clientId 在OAuth2身份验证中,客户端ID与客户端密钥结合使用。 客户端ID和客户端密钥共同允许您的应用程序代表您的帐户运行,方法是将您的应用程序标识到 Salesforce.
clientSecret 客户端密钥与客户端ID结合使用,作为OAuth2身份验证的一部分。 客户端ID和客户端密钥共同允许您的应用程序代表您的帐户运行,方法是将您的应用程序标识到 Salesforce.
apiVersion 的REST API版本 Salesforce 您正在使用的实例。 API版本的值必须使用小数格式设置。 例如,如果您使用的是API版本 52,则必须输入值,如下所示 52.0. 如果此字段留空,则Experience Platform将自动使用最新可用版本。 此值对于OAuth2客户端凭据身份验证是必需的。
connectionSpec.id 连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 的连接规范ID Salesforce 为: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

有关将OAuth用于 Salesforce,阅读 Salesforce OAuth授权流指南.

使用平台API

有关如何成功调用Platform API的信息,请参阅 Platform API快速入门.

创建基本连接

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

POST要创建基本连接ID,请向 /connections 端点并提供您的 Salesforce 请求正文中的身份验证凭据。

API格式

POST /connections

请求

基本身份验证

以下请求为创建基本连接 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 的URL Salesforce 实例。
auth.params.username 与您的关联的用户名 Salesforce 帐户。
auth.params.password 与您的关联的密码 Salesforce 帐户。
auth.params.securityToken 与您的关联的安全令牌 Salesforce 帐户。
connectionSpec.id 此 Salesforce 连接规范ID: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.
OAuth 2客户端凭据

以下请求为创建基本连接 Salesforce 使用OAuth 2客户端凭据:

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 的URL Salesforce 实例。
auth.params.clientId 与您的关联的客户端ID Salesforce 帐户。
auth.params.clientSecret 与您的关联的客户端密钥 Salesforce 帐户。
auth.params.apiVersion 的REST API版本 Salesforce 您正在使用的实例。
connectionSpec.id 此 Salesforce 连接规范ID: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

响应

成功的响应将返回您新创建的基本连接及其唯一ID。

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

后续步骤

在本教程之后,您已创建一个 Salesforce 基本连接使用 Flow Service API。 您可以在下列教程中使用此基本连接ID:

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