Typescript SDK Version 1.x.x

• 语言: 英语
• 格式: .pdf
• 来源: www.zoho.com

摘要

文档详细介绍了Zoho CRM TypeScript SDK的功能、安装配置和使用方法。SDK支持创建与Zoho CRM集成的TypeScript客户端应用程序，提供了包括令牌持久化、数据库存储和文件存储在内的多种配置选项。지원多用户功能，通过Initializer的switchUser方法实现用户切换，并提供了详细的类层次结构和示例代码。文档还记录了当前版本和之前版本的功能更新及问题修复，包括改进的错误处理和增强的数据对象处理能力。

AI总结

以下是对《Typescript SDK Version 1.x.x》文档内容的中文总结，重点突出核心观点和关键信息，语言简洁明了，逻辑连贯：

---

### 《Typescript SDK Version 1.x.x》总结

#### 1. 概述
- **SDK功能**: 提供了一种创建与Zoho CRM集成的TypeScript客户端应用程序的方法，支持环境配置、令牌持久化、多用户支持等功能。
- **安装方式**: 通过npm安装，需确保客户端应用具备以下条件：
- Node.js版本12及以上。
- 通过npm安装`@zohocrm/typescript-sdk`包。
- 可以通过`package.json`添加依赖并运行`npm install`命令完成安装。

#### 2. 配置
- **日志记录**: 创建Logger实例，配置日志级别和存储路径。
- **用户标识**: 使用UserSignature类标识当前用户，传入用户邮箱。
- **环境配置**: 通过Domain.Environment模式设置API调用域和URL，如USDataCenter、EUDataCenter等。
- **SDK配置**: 使用SDKConfigBuilder设置选项，如字段验证、自动刷新字段等。

#### 3. 令牌持久化
支持以下四种持久化方式：
- **OAuth持久化**: 使用OAuth机制存储令牌。
- **数据库持久化**: 将令牌存储在数据库中。
- **文件持久化**: 将令牌存储在文件中。
- **自定义持久化**: 用户自定义持久化逻辑。

#### 4. 注册应用
- 需在Zoho CRM平台注册客户端应用，以便获取必要的OAuth scopes。
- 未正确配置OAuth scopes可能导致“OAUTH-SCOPE-MISMATCH”错误。

#### 5. 初始化应用
- 使用Initializer类初始化应用，支持多用户切换。
- 通过`switchUser`方法实现多用户切换，支持代理配置。
- 可通过`removeUserConfiguration`移除用户配置。

#### 6. 样例代码
- 提供了多个示例代码，覆盖用户标识、环境配置、SDK配置、记录操作等功能，帮助开发者快速上手。

#### 7. 响应与异常
- **GET请求**: 返回APIResponse对象，包含状态码和响应对象。
- **POST、PUT、DELETE请求**: 同样返回APIResponse对象。
- **异常处理**: SDKException类包装所有异常，包括SDK异常和其他意外行为。

#### 8. 发布说明
- **当前版本(1.1.1)**: 修复了Windows系统下因文件处理不当导致的“Cannot read property 'hasOwnProperty'”错误。
- **之前版本(1.1.0)**: 支持外部ID。
- **版本1.0.2**: 处理日期对象。
- **版本1.0.1**: 提供了高结构化的SDK，支持各CRM实体的操作，提供了APIResponse、StreamWrapper和SDKException等关键类。

---

### 核心亮点
1. **安装与配置**: 提供了详细的环境和配置要求，确保开发者能快速集成SDK。
2. **多用户支持**: 通过初始化器实现用户切换，灵活适配多用户场景。
3. **持久化方式**: 提供多种令牌持久化方式，满足不同开发需求。
4. **错误处理**: 使用SDKException统一处理异常，便于开发者捕获和处理错误。
5. **发布更新**: 提供了版本更新说明，帮助开发者了解新增功能和问题修复。

总结内容完整，重点突出，语言简洁，逻辑清晰，便于理解和使用。