使用Flow Service API将Salesforce连接到Experience Platform
创建对象:
- 开发人员
阅读本指南,了解如何使用Flow Service API将您的Salesforce源帐户连接到Adobe Experience Platform。
快速入门
本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:
使用Experience Platform API
有关如何成功调用Experience Platform API的信息,请参阅Experience Platform API快速入门指南。
将Salesforce连接到Azure上的Experience Platform
有关如何将Salesforce源连接到Azure上的Experience Platform的信息,请阅读以下步骤。
收集所需的凭据
Salesforce源支持基本身份验证和OAuth2客户端凭据。
要使用基本身份验证将您的Salesforce帐户连接到Flow Service,请提供以下凭据的值:
凭据 | 描述 |
---|---|
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客户端凭据将您的Salesforce帐户连接到Flow Service,请提供以下凭据的值:
凭据 | 描述 |
---|---|
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创建基本连接
基本连接会保留源与Experience Platform之间的信息,包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。 基本连接ID允许您浏览和浏览源中的文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。
要创建基本连接并将您的Salesforce帐户连接到Azure上的Experience Platform,请对/connections
端点发出POST请求,并在请求正文中提供您的Salesforce身份验证凭据。
API格式
POST /connections
以下请求使用基本身份验证为Salesforce创建基本连接:
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"
}
}'
auth.params.environmentUrl
auth.params.username
auth.params.password
auth.params.securityToken
connectionSpec.id
cfc0fee1-7dc0-40ef-b73e-d8b134c436f5
。成功的响应将返回您新创建的基本连接及其唯一ID。
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}
以下请求使用OAuth 2客户端凭据为Salesforce创建基本连接:
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"
}
}'
auth.params.environmentUrl
auth.params.clientId
auth.params.clientSecret
auth.params.apiVersion
connectionSpec.id
cfc0fee1-7dc0-40ef-b73e-d8b134c436f5
。成功的响应将返回您新创建的基本连接及其唯一ID。
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}
将Salesforce连接到Amazon Web Services (AWS)上的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源创建基本连接。
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。
{
"id": "3e908d3f-c390-482b-9f44-43d3d4f2eb82",
"etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}
验证连接状态
要验证连接状态,请向/connections
端点发出GET请求,并提供在创建步骤中生成的基本连接ID。
API格式
GET /connections
请求
以下请求检索基本连接ID的信息: 3e908d3f-c390-482b-9f44-43d3d4f2eb82
。
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' \
响应
以下响应显示处于initializing
状态时基本连接ID的信息: 3e908d3f-c390-482b-9f44-43d3d4f2eb82
。
{
"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"
}
}
}
}
]
以下响应显示处于enabled
状态时基本连接ID的信息: 3e908d3f-c390-482b-9f44-43d3d4f2eb82
。
{
"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: