Site Home  »  最新百会CRM API  »  发布说明

发布说明

Tags:  

2009年10月22日

我们很高兴地宣布百会CRM的GA版API服务发布，API采取XML和JSON格式，以帮助开发者们用他们喜爱的语言进行开发。目前我们已有健壮而更加完善的API方法来处理实时部署的应用。 您在bug识别，新业务模型建立及公开示例方面提供的信息为CRM系统API服务的完善起到许多有价值的建设性作用。

除了GA版的发布之外，我们也对现有API实现做出了改进以满足开发者社区的需求。这些改进包括，取消了搜索方法，新的响应格式，API请求限制及为满足新的CRM业务逻辑产生的新API方法。我们确信，这些改进能极大地帮助您为开发者社区提供更好的使用体验，并使得百会CRM开发平台上一个新的台阶。

重要变更

  • 取消的搜索方法 - getAllSearchRecords和getMySearchRecords  
  • 所有方法的最新响应格式
  • 基于CRM版本的API请求限制
  • 搜索，线索转换及删除等函数的新方法

过期的API

为保持社区成长，为开发者提供更好的服务及高性能密集型操作的优化，我们将取消下列API方法：

API Method
Purpose
getAllSearchRecords 根据搜索关键字获取所有数据，不考虑数据所有者信息
getMySearchRecords 根据搜索关键字获取登录者的所有数据
getAllRecords 更名为getRecords
getEntityRecord 更名为getRecordById

最近，我们在使用getAllSearchRecords和getMySearchRecords 方法时遇到许多过度占用系统资源的情况。为解决这类问题，我们开发了新的搜索方法，getSearchRecords和getSearchRecordsByPDC ，功能是一样的，这些被优化过的新方法表现更好。

截止时间： 2010年1月21日
 

注意：

从2010年1月21日 (12.00 AM PST)起 ，这些方法将失效，如果您仍使用它们系统将给出以下错误信息：

<response>
Unable to process your request. Please verify whether you have entered proper method name, parameter and parameter values
</response>

重要提示：

在截止期限之前，我们强烈建议您用新的搜索方法更新应用 - getSearchRecords或getSearchRecordsByPDC 。如需更多信息请发送邮件到：support@zohocrm.com 

如需了解取消方法的更多信息请参考API指南

最新响应格式

目前，,API响应的XML格式是<fieldlabel value="LEADID"> Field Value </fieldlabel>，包含26个字符(包括空格)，在新的实现中我们缩短了标签大小，更改为<FL val="LEADID"> Field Value </FL> - 一共8个字符，每个字段节约了18 bytes，这将大大提高带宽的利用率。

到2010年1月21日，默认情况下您得到的响应仍然是旧的格式。如果您想在通过API得到CRM新格式的响应，您必须传递一个额外的参数newFormat=1或者2。

重要提示: 请注意，您插入或更新数据时必须使用newFormat=1。

参数 Purpose
newFormat=1 获取数据时排除"null"值
newFormat=2 获取数据时包含"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>
<row no="2">
...
</row>
</Leads>

</result>
</response>

这个例子中，虽然记录空值，但也都完全获取了，这样占用的不必要的带宽。

新格式：


<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>

这里，我们没有获取包含" Null "值的字段，通过newFormat=1参数。

关键点：
  • XML标签从<fieldlable value=""> field value </fieldlable>变更为<FL val=""> field value <FL>
  • 您通过参数newFormat=1可以不用获取"null"值字段 。如果想获取全部字段，使用 newFormat=2 参数。
New Response Format - Available from Oct 22, 2009

EOL of Old Response Format - Jan 21, 2010

API请求数

为更好满足开发者需求，我们将对API请求数做如下限制：

百会CRM Edition API 请求 - 上限
免费版 - 3用户免费 250 调用 / 天 / 机构组
专业版 -  12$ / 用户 /月 250 调用/天 / 许可用户 或 5,000 调用 /天 /机构组， 每种方案都更划算
企业版 - 25$ / 用户 /月

250 调用/天 / 许可用户 或 15,000 调用 /天 /机构组，每种方案都更划算

例如，在免费版中，如果您使用getRecords 方法，您的每个请求可以获取最多200条记录，这样下来，每天可以获取50,000条记录(250 x 200 = 50,000)。

请注意如果您使用getSearchRecords 或 getCVRecords 方法，不管您是什么版本，您每天最多能进行250次调用。

重要提示：

以上限制适用于所有用户。将来如果机构组超过上述限制，我们考虑通知CRM管理员(百会CRM帐户主联系人)。此外，我们也将 为您的集成需求提供API调用统计。
Implementation Date: Jan 21, 2010

 

从2010年1月21日 (12.00 AM PST)起，您 可以根据您的CRM版本进行API请求调用。如果您的请求数超过上限，则超过的部分将不会被处理。为避免数据传输问题，请事先估计您的API请求数量，如 需任何帮助，请联系我们的技术支持 service@baihui.com 或拨打：400-660-8680  

最新API方法

我们非常乐于向您介绍下列方法，以期更好地位开发者社区的发展服务：

API 方法
作用
getSearchRecords

获取API请求中指定的数据
getSearchRecordsByPDC

根据默认预定于的列输入搜索值。
deleteRecords

通过传递ID参数删除记录。
convertLead 转化线索为客户，联系人或商机

我们相信，以上方法在通过API完成搜索功能及开发业务逻辑方面会有出色表现，这些方法可以立即使用在所有版本中。

起始日期：2009年10月22日

 如需了解更多API方法信息请参考API指南

 

其他变更

此外，我们还做出了下列细微变更：

  • 每个API请求最多获取200条记录
  • 所有API方法都将使用新的响应格式(包括新方法)
  • 使用selectColumns参数获取指定字段数据
  • 我们也更新了API指南并发布了官方的开发者论坛
! This page does not exists



 RSS of this page