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

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

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

快速入门

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

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

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

收集所需的凭据

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。
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。
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 指南。

使用平台API

有关如何成功调用平台API的信息,请参阅平台API快速入门指南。

创建基本连接

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

要创建基本连接ID,请向/connections端点发出POST请求,并在请求正文中提供您的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 Salesforce实例的URL。
auth.params.username 与您的Salesforce帐户关联的用户名。
auth.params.password 与您的Salesforce帐户关联的密码。
auth.params.securityToken 与您的Salesforce帐户关联的安全令牌。
connectionSpec.id Salesforce连接规范ID: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5
OAuth 2客户端凭据

以下请求使用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

响应

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

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

后续步骤

通过完成本教程,您已使用Flow Service API创建了Salesforce基本连接。 您可以在下列教程中使用此基本连接ID:

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