V2 Vs V1
Zoho CRM API 的2.0版本对 API 和函数(之前叫自定义函数)的使用产生了很大的影响。 API 1.0版和2.0版的工作流程基本上是相同的,但是语法、输出和方法都发生了变化。
本文档的目的是为了让读者对 API 的两个版本之间的区别有更清晰的了解,并使用户更好地理解版本2.0。
2.0 版的不同之处在于:
- API 响应和输入格式只支持 JSON。
- API 将通过 OAuth 2.0 协议进行身份验证。
- 在版本 2.0 中,提供模块、字段和相关列表的 API 名称,而不是像 1.0 版本那样显示标签。
- API 调用基于 24 小时滚动式计时,而在 1.0 版中,API 的调用限制是基于PST时区的。
- 日期时间值基于 ISO 8601 日期时间格式提供(2018-03-28T10:32:45+05:30)。
- 以 $ 开头的所有 API 名称都是只读 属性。
- 当获取一条记录时,对空字段的响应是 JSON Null。
- 模块 API 名称可以使用 "https://www.zohoapis.com.cn/crm/v2/settings/modules" - 请求 URL 来获取
- 在插入、更新和 upsert APIs中,自动化操作如工作流、审批和蓝图可以通过关键字 “trigger”:[“approval”,”workflow”,”blueprint”]为所有记录触发。
- 在 GET API 中,响应将有一个 info JSON 对象。例如:
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}- page:从指定的页面获取记录列表。默认值是1。
- per_page:获取每个页面可用的记录列表。默认值是200。
- more_records 代表是否要进行额外的 API 调用来获取下一组记录
- V1.0 版的getMyRecords,在 V2.0 版可以用 searchRecords API 来获取
字段属性的变化:
在 API 1.0版 | 在 API 2.0版 |
---|---|
{MODULE}ID (例如: LEADID,CONTACTID,等) | id |
SMOWNERID | 在 Owner JSON 对象 中给出的 ID。 |
{MODULE} OWNER (例如: Lead Owner, Case Owner) | 在 Owner JSON 对象 中给出的名称。 |
SMCREATORID | 在 Created_By JSON 对象 中给出的 ID。 |
Created By | 在 Created_By JSON 对象 中给出的名称。 |
MODIFIEDBY | 在 Modified_By JSON 对象 中给出的 ID。 |
Modified By | 在 Modified_By JSON 对象 中给出的名称。 |
字段格式类型:
字段类型 | V1.0 格式 | V2.0 格式 |
---|---|---|
单行 | <FL val="Single_Line 1"> <![CDATA[这是一个单行]]> </FL> | "Single_Line_1": “这是一个单行”, |
多行 | <FL val="Multi-Line 1"><![CDATA[这是多行的第二行]]></FL> | "Multi_Line_1": "这是 \多行的\第二行", |
邮箱 | <FL val="Email"><![CDATA[email@zoho.com]]><FL> | "Email_1": "email1@email.com", |
电话 | <FL val="Phone 1"><![CDATA[9900000000]]></FL> | "Phone_1": "9900000000", |
选择列表 | <FL val="picklist1"><![CDATA[one]]></FL> | "picklist1": "one", |
多选列表 | <FL val="Multi-Select 1"><![CDATA[选项1;选项 2]]></FL> | "Multi_Select_1": [ "选项 1", "选项 2" ] |
日期 | <FL val="Date 1"><![CDATA[2018-03-29]]></FL> | "Date_1": "2018-03-29", |
日期时间 | <FL val="Date/Time 1"><![CDATA[2018-04-07 10:00:00]]></FL> | "Date_Time_1": "2018-04-07T10:00:00+05:30", |
数字 | <FL val="Number 1"><![CDATA[50000]]></FL> | "Number_1": 50000, |
货币 | <FL val="Currency 1"><![CDATA[230000500]]></FL> | "Currency_1": 230000500, |
小数 | <FL val="Decimal 1"><![CDATA[1234.9]]></FL> | "Decimal_1": 1234.9, |
百分数 | <FL val="Percent 1"><![CDATA[12.3]]></FL> | "Percent_1": 12.3, |
长整数 | <FL val="Long Integer 1"><![CDATA[6780000000780000]]></FL> | "Long_Integer_1": "6780000000780000", |
复选框 | <FL val="Checkbox 1"><![CDATA[true]]></FL> | "Checkbox_1": true, |
URL | <FL val="URL 1"><![CDATA[https://www.zoho.com]]></FL> | "URL_1": "https://www.zoho.com", |
查找 | <FL val="Lookup 1"><![CDATA[9500495sam]]></FL> | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
记录所有者 | <FL val="SMOWNERID">1386586000000078001</FL> <FL val="Lead Owner"<>![CDATA[BruceWills]]></FL> | "Owner": { "name": "Bruce Wills", "id": "1386586000000078001" }, |
布局 | N/A | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
API 方法
方法名称 | 用途 |
---|---|
getRecords | 检索API请求中指定的所有用户数据 |
getRecordById | 通过记录 ID 检索单个记录 |
getDeletedRecordIds | 从回收站检索已删除记录的 ID 列表 |
insertRecords | 将记录插入到所需的Zoho CRM模块中 |
updateRecords | 更新或修改Zoho CRM的记录 |
getSearchRecordsByPDC | 根据预定义的列搜索值 |
deleteRecords | 删除所选记录 |
convertLead | 将线索转化为商机,客户和联系人 |
getRelatedRecords | 检索与主模块相关的记录 |
getFields | 检索模块中可用字段的详细信息 |
updateRelatedRecords | 更新与另一个记录相关的记录 |
getUsers | 检索机构中的用户列表 |
uploadFile | 将一个文件附加到一个记录 |
delink | 将父记录和子记录的关系分离出来 |
downloadFile | 下载附在记录上的文件 |
deleteFile | 删除附在记录上的文件 |
uploadPhoto | 将照片添加到联系人或线索 |
downloadPhoto | 下载联系人或线索的照片 |
deletePhoto | 删除联系人或线索的照片 |
getModules | 从Zoho CRM账户中检索所有模块 |
searchRecords | 检索与您的搜索条件匹配的记录 |