Zoho crm Logo

Zoho CRM API的开放API规范3.0.0 (OAS)

目录

Overview

开放API规范(OAS)是一种描述RESTful API的标准化方式。它定义了API结构、认证方法、端点、请求和响应格式,可以使用JSON或YAML。

为什么使用OpenAPI规范3.0.0?

开放API规范旨在提供:

  • API 端点:请求的URL和 HTTP 方法已指定,并且列出了进行 API 调用请求所需的可选和必需参数。所有可能的 HTTP 响应代码的响应格式均可用。
  • 授权:支持OAuth 2.0认证以确保安全访问。
  • 请求和响应格式:标准化的GET、POST、PUT和DELETE操作的请求格式,详细的响应模式以解释返回的数据结构,以及帮助开发人员调试API请求的错误处理指南。

GitHub 仓库详情

OpenAPI 规范的 Zoho CRM API 托管在 GitHub 上:

  • 最新版本的OAS文档为JSON格式。
  • 请参考GitHub 仓库,所有 OAS 文件都托管在这里。

注意

  • Zoho CRM 的 OAS 文件是通用设计的,展示了标准的 API 端点、请求/响应结构和 HTTP 方法,并不包含任何特定的业务逻辑。
    • 例如,在模块特定的情况下,每个模块需要不同的输入数据,而像 records.json 这样的 OAS 文件可能无法完全覆盖您的应用程序的特定业务需求,因为它们是通用设计的。开发人员需要根据适合您的用例进行规划并手动解决差距,并将其与您的应用程序集成。
  • 每个 Zoho CRM API 的 OAS 文件都包含其相应的 OAuth 范围以访问 Zoho CRM 资源。如果一个范围包含 {module_API_name} 占位符,代表 模块 API 名称,请将其替换为您需要的模块名称。使用 GET - 模块元数据 API 列出您组织中所有可用的模块 API 名称。
    • 例如,ZohoCRM.modules.{module_API_name}.READ 应替换为 ZohoCRM.modules.Leads.READ。
    • 请参阅 OAuth 范围 页面查看所有可用的范围。

       

Swagger API 中心

有许多工具可以访问 OAS 文件。在这里,我们使用了 Swagger 的 API 中心 来演示如何使用 Open API 规范版本 3.0.0 规范 来访问 Zoho CRM API。

如何使用ZohoCRMOpenAPI规范3.0.0

所有 Zoho CRM API 的功能、结构和语法以标准化格式使用 OAS 记录,并将 OAS 文件托管在 GitHub 上,以帮助您将业务与 Zoho CRM 集成。

请按照以下步骤开始:

  1. 前往 Github > Open v8.0

     
    您将看到 Zoho CRM API 的 OAS 文件列表。

     

  2. 选择一个适合您的业务案例的 API 资源。
    在这里,我们使用了 record.json 文件。 

     

  3. 复制所选文件的原始链接。
    右键点击“Raw”并复制链接地址。

     

  4. 前往 Swagger的API中心 > 设计 > Import API (Import您现有的API定义到API中心进行设计)。
    您将导航到"Import API"弹出框。在"路径或URL"字段中粘贴复制的原始链接,然后点击"Import"。

     

  5. 成功导入JSON文件后,您将进入"API 设计Edit器"或"API 定义"页面,在这里您可以使用Open API 规范 (OAS) 查看、定义、Edit和记录您的 API。

与第三方应用集成

  • 使用OpenAPI客户端生成器创建Python、Java、Node.js等SDK。
  • Zoho CRM 的 OAS 文件为 开发者 和 第三方集成商 提供了 Zoho CRM API 的清晰参考,最大限度地减少误解 和 集成错误。

我们已经演示了一个示例 Python SDK 来创建和获取模块中的记录。这是通过使用 Python SDK 中的 record.json OAS 文件中的 create 和 fetch 方法来实现的。请注意,除了 create 和 fetch 方法外,其余代码在所有 SDK 中都是相同的。

Open records.json OAS 文件在 Swagger API Hub 中,按照以下步骤使用 Zoho CRM 的 OpenAPI 规范 (OAS) 文件生成 Python SDK 并将其集成到您的应用程序中。

从 OAS 生成 Python SDK

  • Open Swagger API Hub > 转到 Codegen > Client SDK > Python.
  • 这将下载一个Python SDK压缩文件。

设置 Python SDK

  • 解压下载的SDK文件。
  • 下载Python 运行器 (.py)文件。
  • 将运行文件移动到解压后的Python SDK文件夹中。

配置Authentication

  • 前往 Github > Open v8.0 > Open runner .py 文件。

  • 用你的客户端ID、客户端密钥和刷新令牌替换占位符,以验证API请求

Run Python SDK

  • 在本地IDE中执行runner.py文件。
  • 使用 Python SDK 中的 create 和 fetch 方法,通过 records.json OAS 文件与 Zoho CRM 数据进行交互。

注意

身份验证的设置和执行过程在所有 SDK 中都是相同的。您可以参考 GitHub v8.0 仓库获取更多 OAS 示例文件。