SFDC rest API document

### Salesforce REST API 知识点详解 #### 一、引言与概述 Salesforce REST API 是一种基于 HTTP 协议的编程接口，它允许开发者通过简单、标准的方式访问 Salesforce 数据和服务。该文档版本为 32.0（Winter ’15），提供了全面的指导和示例来帮助用户理解和使用 Force.com REST API。 #### 二、开始使用 Force.com REST API ##### 2.1 了解 Force.com REST 资源 Force.com REST API 的核心是资源(Resource)的概念。资源代表了系统中的实体或功能，例如对象(Object)、记录(Record)等。通过特定的 URI (Uniform Resource Identifier) 来标识这些资源，并通过标准的 HTTP 方法（如 GET、POST、PUT 和 DELETE）来进行操作。 - **对象**：表示数据库表，如账户(Accounts)、联系人(Contacts)等。 - **记录**：对象中的具体数据行。 - **查询**：获取数据的方法之一，通常使用 SOQL (Salesforce Object Query Language) 进行查询。 ##### 2.2 使用压缩 为了提高传输效率，可以使用压缩技术，比如 gzip 或 deflate，来减少数据量。API 支持这些压缩格式，客户端可以通过设置 `Accept-Encoding` 请求头来启用压缩。 ##### 2.3 使用 cURL 示例 文档中提供了许多使用 cURL 工具进行 API 调用的示例，这对于快速测试 API 功能非常有用。 ##### 2.4 认证机制 认证是 REST API 使用的重要组成部分，确保只有授权的用户才能访问数据。主要认证方式包括： - **OAuth 2.0**：推荐的认证方法，支持多种认证流程。 - **Username-Password**：使用用户名和密码进行认证，适用于不涉及用户交互的应用程序。 ##### 2.5 OAuth 认证流程 - **Web Server Flow**：适用于 Web 应用程序，用户在应用程序内登录 Salesforce 并授权。 - **User-Agent Flow**：适用于没有网页界面的应用程序，用户通过浏览器完成认证过程。 - **Username-Password Flow**：适用于不需要用户界面的脚本或服务器端应用。 ##### 2.6 获取更多资源 文档还提到了一些获取额外资源的方法，例如官方论坛、博客和社区等，这些都是学习和解决问题的好地方。 #### 三、快速入门指南 快速入门部分提供了一个简单的流程来帮助用户快速上手： - **步骤一**：获取一个 Salesforce 开发者版组织。 - **步骤二**：设置授权。 - **步骤三**：使用 cURL 发送 HTTP 请求。 - **步骤四**：浏览示例代码。 #### 四、使用 REST 资源 文档详细介绍了如何使用 REST API 来执行各种操作，包括但不限于： ##### 4.1 获取关于我的组织的信息 可以获取有关当前用户所在组织的信息，例如版本号、限制等。 - **获取 REST API 版本列表**：了解可用的 REST API 版本。 - **获取组织限制**：了解当前组织的限制情况，如用户数量限制等。 - **获取 REST 资源列表**：列出所有可用的 REST 资源。 ##### 4.2 对象管理 - **获取对象列表**：列出所有可访问的对象。 - **获取对象元数据**：获取对象的详细信息，如字段名、数据类型等。 - **创建、更新和删除记录**：对数据库中的记录进行 CRUD 操作。 ##### 4.3 记录操作 - **获取字段值**：从标准对象或外部对象记录中获取字段值。 - **使用外部 ID**：根据外部 ID 检索记录或更新记录。 - **附件管理**：上传或下载附件。 ##### 4.4 查询与搜索 - **执行 SOQL 查询**：使用 SOQL 进行复杂的查询操作。 - **获取查询性能反馈**：评估查询性能并优化查询。 - **字符串搜索**：搜索文本内容。 #### 五、总结 通过本篇文档，我们不仅了解了 Salesforce REST API 的基本概念和使用方法，还深入学习了如何通过 REST API 进行各种操作，包括对象管理、记录操作以及查询与搜索等功能。这为开发人员提供了强大的工具来构建高度集成的应用程序和服务。未来版本的文档可能会增加更多的功能和改进，因此持续关注官方文档是非常重要的。