发布说明
最低 API 使用限制有所提高
我们提高了所有版本中的最低 API 限制,以便改善您的 API 使用体验。
Zoho CRM 版本 | API 请求 - 上限 |
免费版本 | 1000 次请求/天/机构 |
标准版本 |
|
专业版本 |
|
企业版本 |
|
如需了解更多详细信息,请参考API 限制以便了解关于这一改变的更多信息。
发布时间: 2014 年 11 月 1 日
新方法:searchRecords
我们引入了searchRecords方法帮助您从模块中搜索记录。 参考API 指南以便了解关于此新方法的更多信息。
发布时间: 2014 年 10 月 20 日
新方法:getModules 和 getDeletedRecordIds
我们引入了下列方法帮助您从回收箱中检索 CRM 模块列表和已删除记录的 ID:
参考我们的API 指南以便了解关于这些新方法的更多信息。
发布时间: 2014 年 8 月 7 日
API 请求的数量
Zoho CRM API 在所有版本的 Zoho CRM 中可用。 如需使用 API,您将需要来自您的 CRM 账户的 Zoho CRM 验证令牌。 请确保您有访问 API 服务的权限。 如果您没有权限,请联系您的 CRM 管理员。
API 限制
Zoho CRM 版本 | API 请求 - 上限 |
免费版本 | 250 次请求/天/机构 |
标准版本 | 最少 - 1000 次请求/天
最多 - 5000 次请求/天/机构或 |
专业版本 | 最少 - 2000 次请求/天
最多 - 10000 次请求/天/机构或 |
企业版本 | 最少 - 3000 次请求/天
最多 - 25000 次请求/天/机构或 |
重要注意事项
- 例如,在免费版本中,如果您使用getRecords 方法,您可以每次请求获取最多 200 条记录,相应地每天获得共计 50000 条记录(250 x 200 = 50,000 条记录)。
- 如果您使用 getSearchRecords 或 getCVRecords 方法,您可以每天发送最多 250 次调用,无论您的 Zoho CRM 版本为何。
发布时间: 2013 年 6 月 15 日
新方法: 使用开发者 API 将文档或照片附在记录中
我们引入了下列方法,可以帮助您将文档或照片附在记录中:
- uploadFile
- downloadFile
- deleteFile
- uploadPhoto
- downloadPhoto
- deletePhoto
您可以在我们的开发者 API 论坛中阅读完整声明。
参考我们的API 指南以便了解关于这些新方法的更多信息。
发布时间: 2012 年 7 月 11 日
引入验证令牌
我们现在在我们的开发者 API 执行中支持验证令牌。
此令牌为永久令牌,仅在您选择删除后无效。
在我们的API 指南中了解关于验证令牌的更多信息。
发布时间: 2012 年 3 月 5 日
引入新方法
我们在我们的开发者 API 中引入了下列方法:
- getFields
- getRelatedRecords
- updateRelatedRecords
API 方法 | 目的 |
getFields | 获取特定模块中可用的字段的所有详细信息。 |
getRelatedRecords | 获取另一条记录相关的记录(主记录)。 . |
updateRelatedRecords | 更新另一条记录相关的记录。 |
您可以在我们的开发者 API 论坛中阅读完整声明。 参考我们的API 指南以便了解关于这些新方法的更多信息。
发布时间: 2012 年 1 月 27 日
仅有来自 2011 年 4 月 28 日的 HTTPS 支持:
目前,我们在执行我们的开发者 API 时支持 HTTP 和 HTTPS。 在未来 4 周的时间安排里,我们计划仅通过 HTTPS 支持所有 API 交易,并永久停止 HTTP 协议。 这一额外的 SSL 256 位安全系统将帮助您保护第三方集成在数据传输过程中避免安全问题。
2011 年 4 月 28 日之后,如果您依然在您的程序中继续使用 HTTP,API 请求将不会得到执行。因此,我希望强烈建议我们的开发者群体从一开始就仅使用 HTTPS 请求调用 Zoho CRM API。
引入新参数调用‘版本’
我们引入了新的参数调用版本用于开发者 API 方法。 您可以利用此参数从“宣传来源”字段获取数值。
在最近对宣传模块进行的强化中,宣传来源字段被删除以支持宣传成员功能。 在此次强化之后:
- 您现在可以将多个线索和联系人与宣传关联。
- 您可以通过导入多个线索/联系人取代对他们一一实施关联节省时间。
- 宣传来源字段在线索和联系人模块中不可用。
在我们的过渡指南中了解关于此次强化的更多信息。
您如何在 API 请求中使用版本参数?
您可以使用方法中的版本参数,以便在您的 API 中从宣传字段获取数值。
值为"1" 的“版本”参数也将获取来自“宣传来源”字段的响应。
值为"2" 的“版本”参数将基于当前的 API 执行获取响应。 来自“宣传来源”字段的值在此案例中不会获取。
这不是必填参数。 直至 2011 年 10 月 30 日,所有响应将基于较早的执行即强化之前的情况获取。 在此期间,如果您希望基于新的执行获取响应,您可以在您的请求中使用值为 '2' 版本参数,即 version=2。
注意:
- 这不是必填参数。
- 直至 2011 年 10 月 30 日,所有响应将基于较早的执行即强化之前的情况获取。 在此期间,如果您希望基于新的执行获取响应,您可以在您的请求中使用值为 '2' 版本参数,即 version=2。
- 2011 年 10 月 30 日过后,我们会停止对版本 1 的支持,仅支持版本 2。
以下是关于“版本”参数使用的示例。
我们也引入了名为 getRelatedRecords 的新 API 方法。 您可以获取另一模块中记录相关的记录(线索、联系人等)。
例如,您可以获取特定宣传相关的线索或联系人。了解更多
发布时间: 2011 年 4 月 17 日
Zoho CRM 开发者 API 的 GA 发布和其它改变
我们非常高兴地宣布针对 Zoho CRM 服务 API 的 GA 发布。 我们的 API 可以 XML 和 JSON 格式提供,这将帮助开发者群体使用他们喜欢的编程语言建立应用程序。 现在我们准备了稳健而且好得多的 API 方法以满足实时部署的需求。 您为找到缺陷、提出新的业务场景和发布示例做出的宝贵贡献帮助我们为我们的 CRM 系统提出更好的 API。 除 GA 发布以外,我们也在我们现有的 API 执行中做了一些重大改变,这让我们可以满足开发者群体未来的需求。 这些改变包括反对搜索方法、新响应格式、限制 API 请求和用于执行其它 CRM 业务逻辑的新 API 方法。 我们真诚地相信,这些改变会极大地帮助我们为开发者群体提供更好的体验,并让 Zoho CRM 开发者平台更上一层楼。
重要改变
- 反对现有的搜索方法 - getAllSearchRecords 和 getMySearchRecords
- 为所有方法执行新的响应格式
- 基于 Zoho CRM 版本限制API 请求
- 为 搜索、线索转换和删除功能引入新方法
反对 API
在保持未来的社区发展、更好的开发者服务和视图中高性能敏感业务的优化的同时,我们正逐步淘汰下列 API 方法:
- getAllSearchRecords
- getMySearchRecords
API 方法 | 目的 |
getAllSearchRecords | 用于不考虑所有权获取所指定搜索词相关的所有数据。 |
getMySearchRecords | 用于就请求中指定的搜索词获取按登录名拥有的数据。 |
getAllRecords | 名称已经变为getRecords |
getEntityRecord | 名称已经变为getRecordById |
之后,我们会遇到大量的资源利用情况,同时执行超出预期的getAllSearchRecords 和getMySearchRecords 。 为了克服这一类情况,我们引入了新的搜索方法getSearchRecords 和 getSearchRecordsByPDC ,他们的目的类似。 我们对这些新方法实施了优化,以获得更好的性能。
产品使用寿命结束日期:2010 年 1 月 21 日
注意:
- 从2010 年 1 月 21 日 (12.00 AM PST) 开始,这些方法将失效,如果您依然使用他们,系统将在您的应用程序中给出下列错误消息:
<response>无法处理您的请求。 请确认您是否输入了正确的方法名称、参数和参数值
</response>
重要注意事项:
在产品使用寿命结束之前,我们强烈建议您使用新的搜索方法getSearchRecords 或 getSearchRecordsByPDC 更新您的应用程序。 如需任何帮助或澄清,请发送邮件给我们:support-crm@zohocorp.com.cn
如需了解关于被反对方法的更多详细信息,请参考我们的API 指南
新响应格式
现在,API 响应的 XML 格式是< fieldlabel value = "LEADID" > Field Value </ fieldlabel>,其中包含开始和结束标签中约 26 个字符(包括空格)。 在我们新的执行中,我们通过将 XML 标签改为 <FL val="LEADID"> Field Value </FL>缩短标签尺寸,共计 8 个字符,每个字段减少了约 18 字节。 这将极大帮助我们优化带宽的利用。
截至 2010 年 1 月 21 日,默认情况下,您会以旧格式得到响应。 如果您想以新格式得到响应,您必须利用 API 请求中newFormat=1 or 2通过额外参数以便从 Zoho CRM 获取数据。
重要注意事项:
请注意,您必须使用newFormat=1参数 XML 数据插入或更新记录。
参数 | 目的 |
newFormat=1 | 获取来自您的 CRM 账户的数据时排除有 "null" 值的字段。 |
newFormat=2 | 获取来自您的 CRM 账户的数据时将有 "null" 值的字段包括在内。 |
旧格式:
<response uri="/crm/private/xml/Leads/getAllRecords">
<result>
<Leads>
<row no="1"> <fieldlabel value="LEADID">1111111111<fieldlabel>
<fieldlabel value="SMOWNERID">222222222</fieldlabel>
<fieldlabel value="Lead Owner">soori</fieldlabel>
<fieldlabel value="Company">NiveSoft</fieldlabel>
<fieldlabel value="First Name">Mutha</fieldlabel>
<fieldlabel value="Last Name">Raja</fieldlabel>
<fieldlabel value="Designation">null</fieldlabel>
<fieldlabel value="Email">null</fieldlabel>
<fieldlabel value="Phone">3434343</fieldlabel>
<fieldlabel value="Fax">null</fieldlabel>
<fieldlabel value="Mobile">null</fieldlabel>
<fieldlabel value="Website">null</fieldlabel>
<fieldlabel value="Lead Source">null</fieldlabel>
<fieldlabel value="Lead Status">null</fieldlabel>
<fieldlabel value="Industry">null</fieldlabel>
<fieldlabel value="No of Employees">0</fieldlabel>
<fieldlabel value="Annual Revenue">0.0</fieldlabel>
<fieldlabel value="Rating">null</fieldlabel>
<fieldlabel value="CAMPAIGNID">null</fieldlabel>
<fieldlabel value="Campaign Source">null</fieldlabel>
<fieldlabel value="SMCREATORID">22222222</fieldlabel>
<fieldlabel value="Created By">jkbmahesh</fieldlabel>
<fieldlabel value="MODIFIEDBY">22222222</fieldlabel>
<fieldlabel value="Modified By">jkbmahesh</fieldlabel>
<fieldlabel value="Created Time">2009-02-22 18:20:38</fieldlabel>
<fieldlabel value="Modified Time">2009-10-05 16:01:32</fieldlabel>
<fieldlabel value="Street">null</fieldlabel>
<fieldlabel value="City">null</fieldlabel>
<fieldlabel value="State">null</fieldlabel>
<fieldlabel value="Zip Code">null</fieldlabel>
<fieldlabel value="Country">null</fieldlabel>
<fieldlabel value="Description">null</fieldlabel>
<fieldlabel value="Skype ID">null</fieldlabel>
<fieldlabel value="Email Opt Out">false</fieldlabel>
<fieldlabel value="Salutation">null</fieldlabel>
<fieldlabel value="rrr">null</fieldlabel>
<fieldlabel value="int field">null</fieldlabel>
<fieldlabel value="Currency (Round Up)">null</fieldlabel>
<fieldlabel value="Auto Num">1</fieldlabel>
<row no="2">
...
</row>
</Leads>
</result>
</response>
在这个示例中,所有字段均获取,忽略记录中的"null"值。 如果您在模块中有 150 个字段,我们就必须为所有字段获取数据,这需要不必要的带宽使用。 新格式:
<response uri="/crm/private/xml/Leads/getAllRecords">
<result>
<Leads>
<row no="1">
< FL val ="LEADID">1111111111</ FL >
<FL val="SMOWNERID">1111122222</FL>
<FL val="Lead Owner">soori</FL>
<FL val="Company">NiveSoft</FL>
<FL val="First Name">Mutha</FL>
<FL val="Last Name">Raja</FL>
<FL val="Email"></FL>
<FL val="Phone">3434343</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
<FL val="SMCREATORID">22222222</FL>
<FL val="Created By">jkbmahesh</FL>
<FL val="MODIFIEDBY">22222222</FL>
<FL val="Modified By">jkbmahesh</FL>
<FL val="Created Time">2009-02-22 18:20:38</FL>
<FL val="Modified Time">2009-10-05 16:01:32</FL>
<FL val="Email Opt Out">false</FL>
<FL val="Auto Num">1</FL>
</row>
<row no="2">
....
</row>
</Leads>
</result>
</response>
在这个示例中,我们未利用通过 newFormat=1 参数获取包含 " Null "值的字段。 关键点:
- XML 标签已经从 <fieldlable value=""> 字段值 </fieldlable> 变为 <FL val=""> 字段值<FL>
- 您可以停止利用"null"值获取记录,即通过 API 请求中的newFormat=1 。 如果您想获取所有字段的数据(包括null值),使用newFormat=2 参数。
新响应格式 - 自 2009 年 10 月 22 日可用
旧响应格式的 EOL - 2010 年 1 月 21 日
API 请求的数量
为了得到更好的性能和开发者服务,我们将限制 API 请求的数量,如下文所示:
Zoho CRM 版本 | API 请求 - 上限 |
免费版本 - 3 个用户免费 | 250 次调用/日/机构 |
专业版本 - 12 美元/用户/月 | 250 次调用/日/用户许可证或 |
标准版本 - 20 美元/用户/月 | 250 次调用/日/用户许可证或 |
企业版本 - 35 美元/用户/月 | 500 次调用/日/用户许可证或 最多: 25000 次调用/日/机构,最少: 3000 次调用/日/机构 |
例如,在免费版本中,如果您使用getSearchRecords 方法,您可以每次请求获取最多 200 条记录,相应地每天获得共计 50000 条记录(250 x 200 = 50,000 条记录)。
注意:
- 如果您使用 getSearchRecords 或 getCVRecords 方法,您可以每天发送最多 250 次调用,无论您的 Zoho CRM 版本为何。
重要注意事项:
上述限制适用于所有我们的现有用户和新用户。 未来,我们计划在您的机构超过上述限制时告知 CRM 管理员(Zoho CRM 账户高级管理员)。 此外,我们也为对您的整合要求进行更好的评估提供 API 数据。
执行日期: 2010 年 1 月 21 日
从2010 年 1 月 21 日(12.00 AM PST)开始,您可以按照您的 Zoho CRM 版本要求 API 调用。 如果您的申请要求的次数超过了上限,您另外的 API 请求将不会得到处理。 为避免数据传输问题,请提前对您的 API 要求进行妥善评估。 如果您需要任何帮助,请联系我们的支持人员 support-crm@zohocorp.com.cn 或拨打我们的电话: +1 888 900 9646
新 API 方法
我们真的非常激动地引入下列新方法,以便让越来越多的开发者群体获得好处:
- getSearchRecords
- getSearchRecordsByPDC
- deleteRecords
- convertLead
API 方法 | 目的 |
getSearchRecords | 获取 API 请求中指定的所有用户数据 |
getSearchRecordsByPDC | 根据 Zoho CRM 实体的默认预定义列搜索值。 |
deleteRecords | 利用通过其 ID 删除记录。 |
convertLead | 将线索转换为账户、联系人和潜在客户。 |
我们很有信心,上述方法在执行搜索功能方面会非常有用,并将让您可以通过我们的 API 设定其它的业务逻辑。 这些方法可即时为所有版本提供。
开始可用日期:2009 年 10 月 22 日
如需关于新 API 方法的更多信息,请参考我们的API 指南
其它改变
此外,我们并入了下列微小改变:
- 每次 API 请求获取最多 200 条记录
- 新的响应格式适用于所有 API 方法(现有方法及新方法)
- 使用selectColumns 参数获取有指定字段的记录
- 我们还曾更新了API 指南并推出了官方 开发者论坛