README

PHP SDK for Zoho CRM 允许开发人员轻松创建可以与 Zoho CRM 集成的客户端 PHP 应用程序。此 SDK 作为 REST API 的包装器，使访问和利用 Zoho CRM 的服务更加容易。通过 OAuth2.0 完成对 CRM API 的身份验证，并使用 PHP SDK 流程化身份验证过程。授权和访问/刷新令牌在 SDK 代码内部生成和管理，从而消除了在 Zoho CRM 和客户端应用程序之间同步数据时手动处理的需求。

此存储库包含 Zoho CRM API v6 的 PHP SDK。有关为该 API 版本发布的 SDK 版本详细信息，请参阅版本。

许可证

Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED 
All rights reserved. 

Licensed under the Apache License, Version 2.0 (the "License"); 
you may not use this file except in compliance with the License. 
You may obtain a copy of the License at 

    https://apache.ac.cn/licenses/LICENSE-2.0 

Unless required by applicable law or agreed to in writing, software 
distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
See the License for the specific language governing permissions and 
limitations under the License.

最新版本

• 6.0.0

  • 处理 API 操作超时错误。

• 5.0.0

  • 处理 rollup_summary 记录数据类型。

• 4.0.0

  • 在 FieldsOperations 类中支持多个字段更新操作。

• 3.0.0

  • 蓝图转换 percentPartialSave 字段数据类型更改（从整数变为浮点数）。
  • 蓝图字段 convertMapping 字段数据类型更改（从 ConvertMapping 变为数组）。
  • 在 GetDownloadAttachmentsDetailsParam 类中添加了新的 id 和 name 参数。
  • 在 EmailRelatedRecordsOperations 类构造函数中添加了新的 type 和 ownerId 参数。
  • 处理记录字段的 API 名称和数据类型。
  • 在 Record FileDetails 类中添加了新的字段（createdTimeS、modifiedTimeS、createdByS、ownerS 和 modifiedByS）。
  • Record multi_user_lookup 类型字段数据类型更改（从 MinifiedUser 数组变为 Record 数组）。

• 2.0.0

  • 在 LeadConverter 类中添加了新的 moveAttachmentsTo 字段。
  • 在 EmailRelatedRecords 状态类中添加了新的 subCategory 字段。
  • 在 Features Detail 类中添加了新的 availableCount 字段。
  • 在 Layouts Sections 中更改了 tabTraversal 字段数据类型。
  • CustomViews 的 favorite 字段数据类型更改（从 bool 变为 int）。
  • 支持以下新 API。
    • CustomViews
      • 更改自定义视图的排序顺序
    • 用户
      • 用户数量
    • 功能
      • 用户许可证数量

• 1.0.0

  • PHP SDK 升级以支持 v6 API。

  • PHP SDK 改进以支持以下新 API

    • 取消订阅链接
    • 查找和合并 API
    • 获取已删除记录的相关记录 API
    • 功能 API
    • 全局拾取列表 API
    • 取消阻止电子邮件 API

对于旧版本，请参考。

将 SDK 包含到项目中

您可以使用 Composer 将 SDK 包含到项目中。对于安装最新版本的 PHP SDK，导航到客户端应用程序的工作区并运行以下命令。

composer require zohocrm/php-sdk-6.0:6.0.0

这样，PHP SDK 将被安装，并在客户端应用程序的工作区中创建一个名为 vendor 的包。

注意

• 访问和刷新令牌是特定于环境和域的。当您处理各种环境和域，如生产环境、沙箱或开发者，以及分别的IN、CN、US、EU、JP、CA或AU时，您必须仅使用在这些相应环境和域中生成的访问令牌和刷新令牌。否则，SDK会抛出错误。例如，如果您在CN域的沙箱环境中生成令牌，则必须仅使用这些令牌在该域和环境中使用。您不能使用为不同环境或域生成的令牌。

• 对于交易联系人角色API和记录API，在生成OAuthtoken时，您需要提供ZohoCRM.settings.fields.ALL作用域以及ZohoCRM.modules.ALL作用域。否则，系统将返回OAUTH-SCOPE-MISMATCH错误。

• 对于相关记录API，生成OAuthtoken所需的范围是ZohoCRM.modules.ALL、ZohoCRM.settings.fields.ALL和ZohoCRM.settings.related_lists.ALL。否则，系统将返回OAUTH-SCOPE-MISMATCH错误。

• 对于批量转换API，在生成OAuthtoken时，您需要提供ZohoCRM.settings.fields.ALL作用域以及ZohoCRM.mass_convert.leads.CREATE和ZohoCRM.mass_convert.leads.READ作用域。否则，系统将返回OAUTH-SCOPE-MISMATCH错误。

有关更多详细信息，请参阅此处。此处。