Salesforce Marketing Cloud API:新手指南
Posted: Mon Dec 02, 2024 9:24 am
如果您正在使用 Salesforce Marketing Cloud,那么您可能听说过 Salesforce Marketing Cloud API。对于许多营销人员来说,API 的概念似乎令人难以理解,但实际上,它是一种强大的工具,可让您充分发挥 Marketing Cloud 平台的潜力。
安东·米尼翁 (Anton Minnion) 头像
安东·米尼翁
4 分钟
带有文本的 3D 电子书封面 AMPscript 代码片段(适用于 Marketing Cloud)免费资源立即下载
目录
什么是 Salesforce Marketing Cloud API?
何时以及为何需要它
SOAP 与 REST API:哪个相关?
您应该在 Marketing Cloud 中使用哪个 API?
使用限制
如何将您的 API 连接至 Marketing Cloud
示例:将 WordPress 连接到您的 API
MarCloud 提供定制 API 支持
无论您是开发人员还是营销人员,试图最大限度地发挥 Marketing Cloud 的功能,了解 API 都可以提升您的策略并简化您的营销流程。
为了帮助您实现这一目标,我整理了这个快速的“新手”指南,解释技术细节并向您展示如何充分利用这个强大的工具。
什么是 Salesforce Marketing Cloud API?
首先,API(应用程序编程接口)本质上是两个系统之间的桥梁,允许它们进行通信。
Salesforce Marketing Cloud API 允许用户从他们的 Marketing Cloud 帐户访问各种功能和数据,而无需手动与平台交互。
对于使用 Marketing Cloud 的企业来说,API 可以改变游戏规则,因为它允许与您可能已经在使用的其他工具(例如您的网站 CMS、事件管理系统或社交媒体网络)集成,从而灵活地扩展您的营销活动的功能。
何时以及为何需要它
您可能想知道,既然 Marketing Cloud 已经拥有直观的用户界面和如此多的原生功能,为什么还要使用 API。好吧,当您需要执行以下操作时,API 就变得不可或缺:
自动执行重复性任务,例如发送电子邮件或更新客户数据。
将 Marketing Cloud 与您正在使用的其他系统(例如 CRM、数据仓库或自定义应用程序)集成。
通过获取可以在您自己的仪表板中直观显示的实时数据来获取自定义报告和见解。
无需人工干预即可扩大您的营销力度。
例如,下面是使用正确的 API 设置可以实现的功能的基本列表:
根据触发的事件或特定客户数据发送个性化电子邮件。
自动管理联系人和订阅者列表。
检索跟踪数据来分析电子邮件活动的效果。
跨不同来源创建或更新客户数据。
通过从外部系统提取数据来构建动态内容以定制电子邮件内容。
简而言之,如果您正在寻找提高效率、减少人工工作量并通过自动化增强营销策略的方法,那么 Salesforce Marketing Cloud API 可以为您提供帮助。
SOAP 与 REST API:哪个相关?
Salesforce Marketing Cloud 支持两种类型的 API:SOAP 和 REST。
SOAP API:SOAP 代表简单对象访问协议。它是一种基于协议的方法,使用 XML 作为其消息格式。虽然 SOAP 功能强大且可以处理复杂的操作,但它通常被认为更为严格,需要更多设置。
REST API:REST 代表表述性状态转移。REST API 使用更简单、更轻量级的通信方式,通常使用 JSON 格式的消息。它更易于使用,尤其是对于从事移动应用或网站的开发人员而言。
对于那些非技术读者,如果这些术语听起来让人不知所措,请不要太过紧张,您不需要了解API 的所有内容即可使用 API。您只需要了解基础知识,或者了解向谁寻求开发支持(附注:MarCloud 是经过认证的 Salesforce 合作伙伴,拥有经验丰富的内部开发人员,如果您想将您的 API 集成工作交给敏捷且专业的团队,请要求致电!)。
您应该在 Marketing Cloud 中使用哪个 API?
对于 Salesforce Marketing Cloud 中的大多数用例,REST API 是最佳选择。它速度更快、更易于实施,并且对于发送电子邮件、管理联系人或检索性能数据等常见营销任务来说也更灵活。SOAP 对于更复杂的操作仍然有用,但对于日常营销自动化,REST 可能更适合您的需求。
使用限制
值得注意的是,Salesforce Marketing Cloud 对 API 的使用施加了一定的限制。需要记住以下几个关键限制:
每日 API 调用限制:这取决于您的 国家代码 +994,阿塞拜疆电话号码 帐户设置,但通常每天在 2,500 到 1,000,000 次调用之间。
并发限制:Marketing Cloud 允许一定数量的同时请求,因此在设置自动化或批量更新时要小心谨慎。
速率限制:为了防止系统过载,Salesforce 会限制 API 请求,以确保客户之间的公平使用。
您可以在Salesforce Marketing Cloud REST API 文档中找到有关 API 限制的更多详细信息。
如何将您的 API 连接至 Marketing Cloud
连接 Salesforce Marketing Cloud API 似乎很技术性,但可以分解为几个易于管理的步骤。以下是有关如何操作的更详细指南:

1. 在 Marketing Cloud 中创建 API 集成
首先登录您的 Salesforce Marketing Cloud 帐户。
单击右上角的个人资料图标,转到设置。
在左侧菜单中,在“平台工具”部分下,选择“应用程序”,然后选择“已安装的软件包”。
单击新建来创建一个包并赋予其相关名称(例如,“WordPress Integration”)。
创建包后,导航到“组件”部分并单击“添加组件”。选择“API 集成”,然后为您的用例选择适当的权限(读/写等)。
2. 生成 API 密钥(客户端 ID 和客户端密钥)
设置 API 集成后,您需要生成 API 密钥,其中包括客户端 ID和客户端密钥。这些是唯一标识符,可让您的外部应用程序(例如 WordPress)与 Marketing Cloud 安全通信。
添加 API 集成组件后,系统将自动为您生成客户端 ID和客户端密钥。请确保安全地复制并存储这些信息,因为您将在下一步中需要它们进行身份验证。
3. 验证你的应用程序
现在,您需要使用生成的客户端 ID 和客户端密钥通过 Salesforce Marketing Cloud 验证您的应用程序。
为此,您需要向 Salesforce 身份验证端点发送POST 请求。您可以使用Postman等工具或以编程方式在应用程序中完成此操作。
POST 请求应包含您的客户端 ID 和客户端密钥以及授权类型信息。身份验证的端点通常如下所示:
发布 https://YOUR_SUBDOMAIN.auth.marketingcloudapis.com/v2/token
在请求正文中包含您的凭据,如下所示:
{
“grant_type”:“客户端凭据”,
"client_id": "您的客户端 ID",
“客户端秘密”:“您的客户端秘密”
}
身份验证成功后,您将收到一个有效期为一定时间(通常为 20 分钟)的访问令牌。您将使用此令牌授权所有未来的 API 请求。
4. 发出 API 请求
有了访问令牌,您现在就可以通过 API 与 Marketing Cloud 进行交互。以下是将数据记录(行)添加到特定数据扩展的示例。
在每个请求的标头中使用访问令牌来访问相关的 API 端点。例如,如果您尝试将新联系人添加到列表中,您的 POST 请求可能如下所示:
标题(您可以在此处提供有关您的呼叫的信息):
内容类型:application/json
授权:持有者访问令牌
POST https://您的子域}.rest.marketingcloudapis.com/hub/v1/dataeventsasync/key:DATAEXTENSION-EXTERNALKEY/rowset
[
{
“键”:{
“SubscriberKey”:“任何唯一密钥”
},
“价值观”:{
“IsActive”:true,
“名字”:“约翰”,
“姓氏”:“史密斯”,
“上次登录”:“2024-05-23T14:32:00Z”,
“关注者数量”:2
}
},
{
“键”:{
“SubscriberKey”:“另一个唯一密钥”
},
“价值观”:{
“IsActive”:true,
“名字”:“琼”,
“姓氏”:“史密斯”,
“上次登录”:“2023-04-21T14:32:00Z”,
“关注者数量”:37
}
}
]
将YOUR_SUBDOMAIN替换为您独有的 Marketing Cloud 子域,并包含特定操作所需的数据(例如发送电子邮件、检索绩效报告或管理联系人数据)。
将DATAEXTENSION-EXTERNALKEY替换为您要添加数据的数据扩展的外部密钥。这可以通过在 UI 中找到数据扩展来找到。
创建 json 有效负载以传送到 Marketing Cloud。在我们这里的示例中,我们将添加两条记录(John 和 Joan Smith)。值需要与目标数据扩展中的字段匹配。就像在 UI 中一样,您应该匹配每个字段的数据类型,否则会出现错误。
示例:将 WordPress 连接到您的 API
让我们通过一个示例来了解如何使用 API 将他们的 WordPress 网站连接到 Salesforce Marketing Cloud,从而根据用户交互自动执行电子邮件营销。
步骤 1:在 Marketing Cloud 中设置 API 集成
首先,在 Marketing Cloud 中创建一个新的 API 集成,类似于上面概述的过程。API 组件允许 WordPress 安全地与 Marketing Cloud 通信,以自动执行操作,例如当订阅者在网站上提交表单时向他们发送新闻通讯。
第 2 步:生成 API 密钥
集成准备就绪后,WordPress 管理员将生成必要的客户端 ID和客户端密钥。这些凭证是使用 Marketing Cloud 验证 WordPress 身份所必需的。
步骤 3:在 WordPress 中进行身份验证
在 WordPress 方面,可以使用WP Fusion等插件或自定义 API 集成来处理 API 请求。管理员将Marketing Cloud 中的客户端 ID和客户端密钥输入到插件设置中。然后,插件使用此信息向 Salesforce 的身份验证端点发送 POST 请求并接收访问令牌。
步骤 4:自动化 API 请求
一旦通过身份验证,该插件就可以将 WordPress 表单中的数据直接发送到 Marketing Cloud。例如,当用户在 WordPress 网站上提交订阅表单时,该插件会触发 API 请求,以将用户添加为Marketing Cloud 中的联系人。
POST 请求可能如下所示:
发布 https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com/contacts/v1/contact
{
“电子邮件”:“[email protected]”,
“属性”: {
“名字”:“约翰”,
“姓氏”:“史密斯”
}
}
这会自动将新订阅者添加到 Marketing Cloud 中的预定义列表中,触发欢迎电子邮件或将其添加到点滴活动中。
通过这种集成,WordPress 网站现在可以向 Salesforce Marketing Cloud 发送实时数据,确保订阅者根据他们在网站上的活动及时收到个性化电子邮件。这种自动化简化了营销流程,并确保不会错过任何潜在客户。
MarCloud 提供定制 API 支持
浏览 Salesforce Marketing Cloud API 可能令人望而生畏,特别是如果您不是开发人员的话。这就是 MarCloud 的作用所在。作为经过认证的 Salesforce Marketing Cloud 顾问,我们可以帮助您集成、优化和释放 API 的全部功能,让您的营销更加高效、有效。
安东·米尼翁 (Anton Minnion) 头像
安东·米尼翁
4 分钟
带有文本的 3D 电子书封面 AMPscript 代码片段(适用于 Marketing Cloud)免费资源立即下载
目录
什么是 Salesforce Marketing Cloud API?
何时以及为何需要它
SOAP 与 REST API:哪个相关?
您应该在 Marketing Cloud 中使用哪个 API?
使用限制
如何将您的 API 连接至 Marketing Cloud
示例:将 WordPress 连接到您的 API
MarCloud 提供定制 API 支持
无论您是开发人员还是营销人员,试图最大限度地发挥 Marketing Cloud 的功能,了解 API 都可以提升您的策略并简化您的营销流程。
为了帮助您实现这一目标,我整理了这个快速的“新手”指南,解释技术细节并向您展示如何充分利用这个强大的工具。
什么是 Salesforce Marketing Cloud API?
首先,API(应用程序编程接口)本质上是两个系统之间的桥梁,允许它们进行通信。
Salesforce Marketing Cloud API 允许用户从他们的 Marketing Cloud 帐户访问各种功能和数据,而无需手动与平台交互。
对于使用 Marketing Cloud 的企业来说,API 可以改变游戏规则,因为它允许与您可能已经在使用的其他工具(例如您的网站 CMS、事件管理系统或社交媒体网络)集成,从而灵活地扩展您的营销活动的功能。
何时以及为何需要它
您可能想知道,既然 Marketing Cloud 已经拥有直观的用户界面和如此多的原生功能,为什么还要使用 API。好吧,当您需要执行以下操作时,API 就变得不可或缺:
自动执行重复性任务,例如发送电子邮件或更新客户数据。
将 Marketing Cloud 与您正在使用的其他系统(例如 CRM、数据仓库或自定义应用程序)集成。
通过获取可以在您自己的仪表板中直观显示的实时数据来获取自定义报告和见解。
无需人工干预即可扩大您的营销力度。
例如,下面是使用正确的 API 设置可以实现的功能的基本列表:
根据触发的事件或特定客户数据发送个性化电子邮件。
自动管理联系人和订阅者列表。
检索跟踪数据来分析电子邮件活动的效果。
跨不同来源创建或更新客户数据。
通过从外部系统提取数据来构建动态内容以定制电子邮件内容。
简而言之,如果您正在寻找提高效率、减少人工工作量并通过自动化增强营销策略的方法,那么 Salesforce Marketing Cloud API 可以为您提供帮助。
SOAP 与 REST API:哪个相关?
Salesforce Marketing Cloud 支持两种类型的 API:SOAP 和 REST。
SOAP API:SOAP 代表简单对象访问协议。它是一种基于协议的方法,使用 XML 作为其消息格式。虽然 SOAP 功能强大且可以处理复杂的操作,但它通常被认为更为严格,需要更多设置。
REST API:REST 代表表述性状态转移。REST API 使用更简单、更轻量级的通信方式,通常使用 JSON 格式的消息。它更易于使用,尤其是对于从事移动应用或网站的开发人员而言。
对于那些非技术读者,如果这些术语听起来让人不知所措,请不要太过紧张,您不需要了解API 的所有内容即可使用 API。您只需要了解基础知识,或者了解向谁寻求开发支持(附注:MarCloud 是经过认证的 Salesforce 合作伙伴,拥有经验丰富的内部开发人员,如果您想将您的 API 集成工作交给敏捷且专业的团队,请要求致电!)。
您应该在 Marketing Cloud 中使用哪个 API?
对于 Salesforce Marketing Cloud 中的大多数用例,REST API 是最佳选择。它速度更快、更易于实施,并且对于发送电子邮件、管理联系人或检索性能数据等常见营销任务来说也更灵活。SOAP 对于更复杂的操作仍然有用,但对于日常营销自动化,REST 可能更适合您的需求。
使用限制
值得注意的是,Salesforce Marketing Cloud 对 API 的使用施加了一定的限制。需要记住以下几个关键限制:
每日 API 调用限制:这取决于您的 国家代码 +994,阿塞拜疆电话号码 帐户设置,但通常每天在 2,500 到 1,000,000 次调用之间。
并发限制:Marketing Cloud 允许一定数量的同时请求,因此在设置自动化或批量更新时要小心谨慎。
速率限制:为了防止系统过载,Salesforce 会限制 API 请求,以确保客户之间的公平使用。
您可以在Salesforce Marketing Cloud REST API 文档中找到有关 API 限制的更多详细信息。
如何将您的 API 连接至 Marketing Cloud
连接 Salesforce Marketing Cloud API 似乎很技术性,但可以分解为几个易于管理的步骤。以下是有关如何操作的更详细指南:

1. 在 Marketing Cloud 中创建 API 集成
首先登录您的 Salesforce Marketing Cloud 帐户。
单击右上角的个人资料图标,转到设置。
在左侧菜单中,在“平台工具”部分下,选择“应用程序”,然后选择“已安装的软件包”。
单击新建来创建一个包并赋予其相关名称(例如,“WordPress Integration”)。
创建包后,导航到“组件”部分并单击“添加组件”。选择“API 集成”,然后为您的用例选择适当的权限(读/写等)。
2. 生成 API 密钥(客户端 ID 和客户端密钥)
设置 API 集成后,您需要生成 API 密钥,其中包括客户端 ID和客户端密钥。这些是唯一标识符,可让您的外部应用程序(例如 WordPress)与 Marketing Cloud 安全通信。
添加 API 集成组件后,系统将自动为您生成客户端 ID和客户端密钥。请确保安全地复制并存储这些信息,因为您将在下一步中需要它们进行身份验证。
3. 验证你的应用程序
现在,您需要使用生成的客户端 ID 和客户端密钥通过 Salesforce Marketing Cloud 验证您的应用程序。
为此,您需要向 Salesforce 身份验证端点发送POST 请求。您可以使用Postman等工具或以编程方式在应用程序中完成此操作。
POST 请求应包含您的客户端 ID 和客户端密钥以及授权类型信息。身份验证的端点通常如下所示:
发布 https://YOUR_SUBDOMAIN.auth.marketingcloudapis.com/v2/token
在请求正文中包含您的凭据,如下所示:
{
“grant_type”:“客户端凭据”,
"client_id": "您的客户端 ID",
“客户端秘密”:“您的客户端秘密”
}
身份验证成功后,您将收到一个有效期为一定时间(通常为 20 分钟)的访问令牌。您将使用此令牌授权所有未来的 API 请求。
4. 发出 API 请求
有了访问令牌,您现在就可以通过 API 与 Marketing Cloud 进行交互。以下是将数据记录(行)添加到特定数据扩展的示例。
在每个请求的标头中使用访问令牌来访问相关的 API 端点。例如,如果您尝试将新联系人添加到列表中,您的 POST 请求可能如下所示:
标题(您可以在此处提供有关您的呼叫的信息):
内容类型:application/json
授权:持有者访问令牌
POST https://您的子域}.rest.marketingcloudapis.com/hub/v1/dataeventsasync/key:DATAEXTENSION-EXTERNALKEY/rowset
[
{
“键”:{
“SubscriberKey”:“任何唯一密钥”
},
“价值观”:{
“IsActive”:true,
“名字”:“约翰”,
“姓氏”:“史密斯”,
“上次登录”:“2024-05-23T14:32:00Z”,
“关注者数量”:2
}
},
{
“键”:{
“SubscriberKey”:“另一个唯一密钥”
},
“价值观”:{
“IsActive”:true,
“名字”:“琼”,
“姓氏”:“史密斯”,
“上次登录”:“2023-04-21T14:32:00Z”,
“关注者数量”:37
}
}
]
将YOUR_SUBDOMAIN替换为您独有的 Marketing Cloud 子域,并包含特定操作所需的数据(例如发送电子邮件、检索绩效报告或管理联系人数据)。
将DATAEXTENSION-EXTERNALKEY替换为您要添加数据的数据扩展的外部密钥。这可以通过在 UI 中找到数据扩展来找到。
创建 json 有效负载以传送到 Marketing Cloud。在我们这里的示例中,我们将添加两条记录(John 和 Joan Smith)。值需要与目标数据扩展中的字段匹配。就像在 UI 中一样,您应该匹配每个字段的数据类型,否则会出现错误。
示例:将 WordPress 连接到您的 API
让我们通过一个示例来了解如何使用 API 将他们的 WordPress 网站连接到 Salesforce Marketing Cloud,从而根据用户交互自动执行电子邮件营销。
步骤 1:在 Marketing Cloud 中设置 API 集成
首先,在 Marketing Cloud 中创建一个新的 API 集成,类似于上面概述的过程。API 组件允许 WordPress 安全地与 Marketing Cloud 通信,以自动执行操作,例如当订阅者在网站上提交表单时向他们发送新闻通讯。
第 2 步:生成 API 密钥
集成准备就绪后,WordPress 管理员将生成必要的客户端 ID和客户端密钥。这些凭证是使用 Marketing Cloud 验证 WordPress 身份所必需的。
步骤 3:在 WordPress 中进行身份验证
在 WordPress 方面,可以使用WP Fusion等插件或自定义 API 集成来处理 API 请求。管理员将Marketing Cloud 中的客户端 ID和客户端密钥输入到插件设置中。然后,插件使用此信息向 Salesforce 的身份验证端点发送 POST 请求并接收访问令牌。
步骤 4:自动化 API 请求
一旦通过身份验证,该插件就可以将 WordPress 表单中的数据直接发送到 Marketing Cloud。例如,当用户在 WordPress 网站上提交订阅表单时,该插件会触发 API 请求,以将用户添加为Marketing Cloud 中的联系人。
POST 请求可能如下所示:
发布 https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com/contacts/v1/contact
{
“电子邮件”:“[email protected]”,
“属性”: {
“名字”:“约翰”,
“姓氏”:“史密斯”
}
}
这会自动将新订阅者添加到 Marketing Cloud 中的预定义列表中,触发欢迎电子邮件或将其添加到点滴活动中。
通过这种集成,WordPress 网站现在可以向 Salesforce Marketing Cloud 发送实时数据,确保订阅者根据他们在网站上的活动及时收到个性化电子邮件。这种自动化简化了营销流程,并确保不会错过任何潜在客户。
MarCloud 提供定制 API 支持
浏览 Salesforce Marketing Cloud API 可能令人望而生畏,特别是如果您不是开发人员的话。这就是 MarCloud 的作用所在。作为经过认证的 Salesforce Marketing Cloud 顾问,我们可以帮助您集成、优化和释放 API 的全部功能,让您的营销更加高效、有效。