Site Home  »  最新百会CRM API  »  生成API Ticket

生成API Ticket

Tags:  

百会CRM API目前可在所有版本中使用，免费版(单用户或三用户)，专业版，企业版。您可以在CRM帐号中要求生成API Key，CRM帐号将自动为您生成。请确认您有权限访问API服务，如果没有权限请直接联系您的CRM管理员。

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次调用。

生成API Key

  1. 使用管理员权限登录百会CRM。
  2. 进入设置 > 管理设置 > 开发者API链接。

生成Ticket

如需生成API ticket ID，可通过安全链接发送身份验证请求到百会帐号服务器如下：

https://accounts.zoho.com/login?servicename=ZohoCRM&FROM_AGENT=true&LOGIN_ID=Zoho Username or Email Address&PASSWORD=Password

URL中必须包含的参数包括：
参数类型描述
servicenameZohoCRM指定服务名称是CRM
FROM_AGENTBooleanTrue
LOGIN_IDString用户百会ID或邮件ID
PASSWORDString百会ID密码

根据请求URL的参数不同，您可以获得下列格式的响应：

参数类型描述
CommentStringTicket生成的时间日期
WARNINGString如果传入参数不正确，用户会得到这样的告警信息，否则返回null。
TICKETString生成的Ticket
RESULTBooleanticket生成成功返回TRUE，否则返回FALSE。

重要提示：

  • API有效期是7天，7天之后您必须重新生成新的ticket以便继续工作。如果您没有及时更新，则会收到系统返回的4834 - 无效的Ticket ID 错误信息。
  • 我们强烈建议您不要为每个API请求生成一个API ticket,您可以在7天之内使用同一个ticket，不会有任何问题。

响应格式


目前，,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/getRecords">
<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/getRecords">
<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">Muthu</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 参数。
! This page does not exists



 RSS of this page