欢迎使用百会CRM!
使用百会CRM API，您可以从您的百会CRM帐号获取CRM数据保存为XML或JSON格式，并且可以集成您的其它商业应用到百会CRM。
获取百会CRM API Key
百会CRM API服务适用于任意版本，例如： 免费版(单用户或3用户) 、专业版、企业版。
提示：如果您使用的是百会CRM - 单用户免费版本，首先添加第二个用户来启用管理设置页面的请求API Key链接。获得关于添加用户的更多信息，请参考： 系统管理
请求API key
- 以管理员身份登录百会CRM。
- 单击设置>管理设置>生成API Key链接。
- 系统提示：您的API Key已生成并发送到您的邮箱，请查收邮件。如果需要帮助，请和我们联系。
个人用户生成API key
- 以管理员身份登录百会CRM。
- 单击设置>管理设置>生成API Key链接。
- 系统提示：您的API Key已生成并发送到您的邮箱，请查收邮件。如果需要帮助，请和我们联系。
生成API Key
- 以管理员权限登录到百会CRM。
- 选择设置 > 开发者空间 > Crm API Key 链接。
生成Ticket
初始化API请求时，您需要向百会CRM传递ticket参数(加密的字母数字字符串)以验证用户身份。为生成Ticket，您需要通过安全连接向百会帐号发送一个有效的HTTP POST请求。
POST格式请求示例：
<form method="POST" action="https://accounts.baihui.com/login" target="_self">
<input type="hidden" name="LOGIN_ID" value="[Baihui Username or Email ID]">
<input type="hidden" name="PASSWORD" value="[Password for Baihui ID]">
<input type="hidden" name="FROM_AGENT" value="true">
<input type="hidden" name="servicename" value="BaihuiCRM">
<input type="submit" value="Generate Ticket" class="divbutton" name="submit">
</form>
URL格式请求示例：
https://i.baihui.com/login?servicename=BaihuiCRM&FROM_AGENT=true&LOGIN_ID=Baihui Username or Email Address&PASSWORD=Password重要提示:
- 您的API ticket有效期为7天。7天之后您必须重新生成新的ticket从而继续使用百会CRM的API功能。如果没有按时更新ticket ID，API请求会返回4834 - 无效的Ticket ID错误。
- 我们强烈建议您无须为每次API请求都生成新的Ticket，您可以使用同一个ticket达7天时间，在这段有效期内Ticket将不会出现任何问题。
百会CRM模块
使用API获取百会CRM数据的步骤
1. 获取数据到JSON对象而不是到xml，叫做json，如：http://crm.baihui.com/crm/private/json/Leads/getMyRecords
2. 为了获取各个不同模块的数据，要使用相应模块名称。我们以线索为例，它可以替换为客户、联系人、潜在客户等。
3. 获取数据时，所有的字段将集中到一个模块中。
4. 一批最多可以获取2000个记录。如果您想获取多于2000个记录，您可以通过迭代来获取：
例如：
迭代1 : fromIndex=1&toIndex2000
迭代2 : fromIndex=2000&toIndex=4000 等等
5. fromIndex和toIndex不是必选项。默认情况下， fromIndex为1，toIndex为2000
6. sortColumnString和sortOrderString也不是必选项。默认情况下，获取最近创建的记录实体。例如，如果您想获取按公司名称升序排列的所有线索记录，您可以使用下面的命令：
sortColumnString=Company&sortOrderString=sort_asc。如果是降序，sortOrderString应是"sort_desc"。
7. lastModifiedTime ：此参数适用于上述任意方法。此参数的取值应是"yyyy-MM-dd HH:mm:ss" format.
示例1：
要获取按客户名称降序排列的第20到第2000个记录，并保存为JSON格式，正确的URL应是：
http://crm.baihui.com/crm/private/json/Accounts/getAllRecords?
loginName=demo@zohocrm.com&apikey=sbdjEDBDJ1323&fromIndex=
20&toIndex=2000&sortColumnString=Account Name&sortOrderString=sort_desc
示例2：
要获取所有在2008-05-27 00:00:00之后创建/修改的客户记录，并保存为XML格式，正确的URL应是：
http://crm.baihui.com/crm/private/xml/Accounts/getAllRecords?
loginName=demo@zohocrm.com&apikey=
sbdjEDBDJ1323&lastModifiedTime="2008-05-27 00:00:00"
插入记录到百会CRM：
要插入记录到百会CRM，请执行下面的步骤：
1. url应是http://crm.baihui.com/crm/private/xml/Leads/insertRecords
2. 参数如下：
a. loginName：百会CRM登录ID。
b. apikey：在百会CRM中请求的API key。
c. xmlData：这是XML串，格式应该与您获取API时如何获得XML记录的格式是相同的。
示例3：
要插入记录到百会CRM，xml数据格式应如下：
http://crm.baihui.com/crm/private/xml/Leads/insertRecords
1. loginName=demo@baihuicrm.com
2. apikey=sbdjEDBDJ1323
3. xmlData=如下所示
<Leads>
<row no="1"><fieldlabel value="Lead Source">Web Download</fieldlabel>
<fieldlabel value="First Name">contacto 1</fieldlabel>
<fieldlabel value="Last Name">apellido</fieldlabel>
<fieldlabel value="Email">testing@testing.com</fieldlabel>
<fieldlabel value="Title">Manager</fieldlabel>
<fieldlabel value="Phone">1234567890</fieldlabel>
<fieldlabel value="Home Phone">0987654321</fieldlabel>
<fieldlabel value="Other Phone">1212211212</fieldlabel>
<fieldlabel value="Fax">02927272626</fieldlabel>
<fieldlabel value="Mobile">292827622</fieldlabel>
</row>
</Leads>
请提交这些参数而不是获取( 作为查询字符串)。
更新数据到百会CRM：
要更新数据到百会CRM，请执行如下操作：
1. url应是http://crm.baihui.com/crm/private/xml/Leads/updateRecords
2. 参数如下：
a. loginName：百会CRM登录ID。
b. apikey：从百会CRM请求的API key。
c. xmlData：这是XML串，格式应该与您获取API时如何获得XML记录的格式是相同的。
d. id：要更新的记录ID。
示例4：
要更新记录到百会CRM，xml数据格式应如下：
http://crm.baihui.com/crm/private/xml/Leads/updateRecords
1. loginName=demo@baihuicrm.com
2. apikey=sbdjEDBDJ1323
3. xmlData=如下所示
4. id = 1000000019001
<Leads>
<row no="1"><fieldlabel value="Lead Source">Web Download</fieldlabel>
<fieldlabel value="First Name">contacto 1</fieldlabel>
<fieldlabel value="Last Name">apellido</fieldlabel>
<fieldlabel value="Email">testing@testing.com</fieldlabel>
<fieldlabel value="Title">Manager</fieldlabel>
<fieldlabel value="Phone">1234567890</fieldlabel>
<fieldlabel value="Home Phone">0987654321</fieldlabel>
<fieldlabel value="Other Phone">1212211212</fieldlabel>
<fieldlabel value="Fax">02927272626</fieldlabel>
<fieldlabel value="Mobile">292827622</fieldlabel>
</row>
</Leads> 
Uploading ....