应使用哪个 API？

何时使用 REST API

REST API 提供强大、方便和简单的基于 REST 的服务界面，用于与 Salesforce 进行交互。其优点包括集成和开发轻松，并且是与移动应用程序和 Web 项目配合使用的绝佳的技术选择。对于某些项目，您可以将 REST API 与其他 Salesforce REST API 一起使用。要构建适用于创建、读取、更新和删除记录的 UI，其中包含构建适用于列表视图、操作和依赖选项列表的 UI，使用用户界面 API。要在 Lightning、CMS 受管内容、Experience Cloud 站点或 Chatter 上为 B2B Commerce 构建 UI，请使用连接 REST API。如果您有许多记录需要处理，请考虑使用批量 API，这是基于 REST 原则并针对大型数据集进行优化。

请查看 REST API 开发人员指南。

何时使用 SOAP API

SOAP API 提供强大、方便和简单的基于 SOAP 的 Web 服务界面，用于与 Salesforce 进行交互。您可使用 SOAP API 创建、检索、更新或删除记录。您也可以使用 SOAP API 执行搜索和更多功能。在任何支持 Web 服务的语言中使用 SOAP API。

例如，您可以使用 SOAP API 将 Salesforce 与您组织的 ERP 和财务系统集成。您还可以为公司入口网站提供实时销售和支持信息，并在关键业务系统中填写客户信息。

请查看 SOAP API 开发人员指南。

何时使用连接 REST API

连接 REST API 提供对 B2B Commerce for Lightning、CMS 受管内容、Experience Cloud 站点、文件、通知、主题等的编程访问权限。使用连接 REST API，显示 Chatter 摘要、用户和小组，特别是在移动应用程序中。

请参阅连接 REST API 开发人员指南。

何时使用 Apex REST API

在您希望公开 Apex 类和方法以便外部应用程序可以通过 REST 架构访问代码时，使用 Apex REST API。Apex REST API 支持 OAuth 2.0 和会话 ID 授权。

见Apex开发人员指南:将 Apex 类公开为 REST Web 服务。

何时使用 Apex SOAP API

在您希望将 Apex 方法公开为 SOAP Web 服务，以便外部应用程序可以通过 SOAP 访问代码时，使用 Apex SOAP API。

Apex SOAP API 支持 OAuth 2.0 和会话 ID 授权。

见Apex开发人员指南:将 Apex 方法公开为 SOAP Web Services 和 SOAP API 开发人员指南：Apex 相关调用。

何时使用 Analytics REST API

您可以使用 Analytics REST API 以编程的方式访问 CRM Analytics 资产，例如数据集、镜头和仪表板。发送查询并访问已导入 Analytics 平台的数据集。创建并检索镜头。访问 XMD 信息。检索数据集版本列表。创建并检索 CRM Analytics 应用程序。创建、更新并检索仪表板。检索应用程序的依赖列表。决定用户可以使用哪个功能。使用快照。操纵重复的数据集。

请参阅 Analytics REST API 开发人员指南。

何时使用用户界面 API

对于构建适用于原生移动应用程序和自定义 Web 应用程序的 Salesforce UI，使用与 Salesforce 用于构建 Lightning Experience 和适用于 Android 与 iOS 的 Salesforce 及移动 Web 相同的 API。通过构建用户界面，用户可以使用记录、列表视图、操作、收藏夹等。您不仅在一次响应中获取数据和元数据，而且该响应会匹配由 Salesforce 管理员对组织实施的更改。您无需担心布局、选项列表、字段级安全性或共享 — 您需要做的全部事情就是构建用户喜欢的应用程序。

请参阅用户界面 API 开发人员指南。

何时使用 GraphQL API

通过在单个请求中仅返回客户需要的数据，构建高度响应和可扩展的应用程序。GraphQL API 通过字段选择、资源聚合和模式自检克服了传统 REST API 带来的挑战。字段选择减少了有效负载的大小，只发送回查询中包含的字段。聚合减少了客户端和服务器之间的往返行程，在单个响应中返回一组相关资源。模式自检使用户能够查看用户有权访问的类型、字段和对象。

请查看 GraphQL API 开发人员指南。

何时使用 Tooling API

使用 Tooling API 将 Salesforce 元数据与其他系统集成。元数据类型会公布为 sObjects，因此您可以访问一种复杂类型组件。此字段级别访问权限可以加快复杂元数据类型上的操作。您也可以为 Force.com 应用程序构建自定义开发工具。例如，使用 Tooling API 管理和部署 Apex 类和触发器及 Visualforce 页面和组件的工作副本。您还可以设置检查点或堆转储标记、执行匿名 Apex 并访问日志和代码覆盖率信息。

支持 REST 和 SOAP。

请参阅 Tooling API。

何时使用批量 API 2.0

使用批量 API 2.0 异步查询、查询所有、插入、更新、更新插入或删除大量记录。批量 API 2.0 在 Salesforce REST 框架中设计。

任何包含超过 2000 条记录的数据操作都是 Bulk API 2.0 的理想选择，将有助于成功准备、执行和管理利用批量框架的异步 工作流。少于 2000 条记录的作业应该涉及 REST（例如，复合）或 SOAP 中的“大容量”同步调用。

当处理大量数据时，它是大规模创建、读取、更新和删除 (CRUD) 记录的最简单的方法。如果您的作业只包括一种 sObject 类型，或者每天提取高达 1 TB 的数据，那么批量 API 2.0 是 Salesforce API 的首选。

请查看 Bulk API 2.0 和 Bulk API 开发人员指南。

何时使用元数据 API

使用元数据 API 可检索、部署、创建、更新或删除组织的自定义。最常见的用途是从 Sandbox 或测试组织迁移更改到您的生产环境。元数据 API 用于管理自定义设置和构建可以管理元数据模型（而非数据本身）的工具。

访问元数据 API 中的功能的最简单方法是使用 Salesforce Extensions for Visual Studio Code 或 Salesforce CLI。这两款工具构建在元数据 API 顶部，并使用标准工具简化使用元数据 API 的工作。

• Salesforce Extensions for Visual Studio Code 包括用于在轻量级、可扩展的 VS 代码编辑器中在 Salesforce 平台上进行开发的工具。这些工具提供了与开发组织（临时组织、Sandbox 和 DE 组织）、Apex、Aura 组件和 Visualforce 一起工作的功能。
• 如果您使用脚本或命令行在本地目录和 Salesforce 组织之间移动元数据，Salesforce CLI 是理想的选择。

请查看 元数据 API 开发人员指南。

何时使用发布/订阅 API

您可以使用发布/订阅 API 将外部系统与事件集成在一起。事件流基于通过平台事件的自定义有效负载或通过变更数据捕获的 Salesforce 记录中的变更。在 Salesforce 中，您可以通过 Apex 触发器、进程构建器和 Flow Builder 发布并订阅事件。

发布/订阅 API 旨在实现与 Salesforce 的大规模双向活动集成。使用发布/订阅 API 有效地发布和订阅 Apache Avro 格式的二进制事件消息。发布/订阅 API 基于 gRPC 和 HTTP/2，并使用基于拉的模型，以便您可以控制订阅流。通过发布/订阅 API，您可以使用 gRPC 支持的 11 种编程语言中的一种。

使用满足需求的流事件类型。

• 更改数据捕获事件:通过所有更改字段，接收对 Salesforce 记录的更改。更改数据捕获支持的标准对象多于 PushTopic 事件，并提供更多功能，例如包含更改相关信息的页头字段。
• 平台事件：通过预定义模式，发布并收到自定义负载。数据可以是您定义的任何内容，包含业务数据，例如订单信息。通过定义平台事件，指定要发送的数据。订阅平台事件渠道，以接收通知。
• 原有事件：PushTopic 和一般事件：PushTopic 和一般事件是第一代事件。它们的支持有限，并且不再更新新功能。我们建议您使用变更数据捕获事件而不是 PushTopic 事件，使用平台事件而不是一般事件。

请查看发布/订阅 API 文档。