Zoho CRM API的1.0版本已进入终结阶段,将在2018年12月31日被弃用。我们推荐您查看和使用最新的、更好的 API 2.0。
使用验证令牌
Zoho CRM API 在所有版本的 Zoho CRM 中可用。 如需使用 API,您将需要来自您的 CRM 账户的 Zoho CRM 验证令牌。 请确保您有访问 API 服务的权限。 如果您没有权限,请联系您的 CRM 管理员。
生成验证令牌
如需生成验证令牌,您需要使用下方的 URL 格式发送验证请求至 Zoho 账户。 请确保您是经过确认的用户,否则生成验证令牌时,您可能会收到错误消息 - "ACCOUNT_REGISTRATION_NOT_CONFIRMED"。
URL 格式
API 模式:
如需生成 API 格式的验证令牌,请进行以下操作:
- 登录 Zoho CRM。
- 打开https://accounts.zoho.com 。
- 在 Zoho 账户主页页面,点击两个因素验证。
- 在两个因素验证页面,点击 管理应用程序特定密码。
- 在应用程序特定密码弹出页面,进行以下操作:
- 输入设备或应用程序名称
- 输入当前密码
- 点击生成。 您将收到带空格的新应用程序特定密码。
- 删除密码中的空格,包括在以下 API 模式 URL 中以生成验证令牌。
https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoCRM/crmapi&EMAIL_ID=[Username/EmailID]&PASSWORD=[Password]&DISPLAY_NAME=[ApplicationName]
与此 URL 一起通过的参数为:
参数 | 说明 |
EMAIL_ID | 指定您的 Zoho CRM 用户名和邮件 ID |
scope* | 将数值指定为 ZohoCRM/crmapi |
PASSWORD | 指定您的 Zoho CRM 密码 |
DISPLAY_NAME | 指定说明使用此验证令牌之目的的应用程序名称。 例如 "MailChimp" 或 "Google Apps" |
如需了解更多信息,请参考 两个因素验证帮助页面。
浏览器模式:
如需以浏览器模式生成验证令牌,则采取以下操作:
- 登录 Zoho CRM。
- 点击 (设置图标)> 设置 > CRM扩展 & API > API > CRM API。
- 点击设置图标并点击验证令牌生成链接。
- 现在输入您想生成验证令牌的您的应用程序名称(例如 "MailChimp")。
注意: 为了轻松识别生成验证令牌的目的,需要应用程序名称。 该名称用于在不同的应用程序之间区分验证令牌的生成。
重要注意事项
- 用户验证令牌必须保密。
- 请勿在公共论坛、公共存储库的任何地方或您网站的客户端侧 HTML 或 JavaScript 等代码中暴露您的验证令牌。
- 将其暴露在公众面前可能导致数据被窃、丢失或损坏。
样本响应
#
#Wed Feb 29 03:07:33 PST 2012
AUTHTOKEN=bad18eba1ff45jk7858b8ae88a77fa30
RESULT=TRUE
注意:
- 验证令牌可在您所有的 API 调用中使用。 您也可以查看 URL 格式,其位置为设置 > 开发者空间 > CRM API。
- 您需要登录您的 CRM 账户以便使用浏览器模式。
示例
以下是获取记录的示例:
https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=7d987658943g4j09h43dd0b167dda34b&scope=crmapi
管理验证令牌
您可以查看、删除和重新生成 从‘我的 Zoho 账户’页面您的账户生成的验证令牌。
- 登录 Zoho CRM
- 打开 [用户名] > 我的 Zoho 账户
- 在我的 Zoho 账户页面,点击设置>有效验证令牌
在此页面,您也可以 移除或重新生成验证令牌。
注意:
- 移除验证令牌将永久删除令牌。
- 如果您重新生成验证令牌,请使用新令牌更新您的程序。
须牢记的要点
- 验证令牌是用户专属的,而且是永久令牌。
- 一旦删除,现有令牌将永久删除。 新令牌必须在所有 API 调用中进行替换。
- 如果用户取消激活,则用户账户的验证令牌将变得无效。
- 如果您的机构超过了 API 限制,我们将通知 CRM 用户(生成验证令牌的用户)。
- 如果您的申请要求的次数超过了上限,您另外的 API 请求将得到处理。 为避免数据传输问题,请提前对您的 API 要求进行妥善评估。 如果您需要任何帮助,请联系我们的支持人员 support-crm@zohocorp.com.cn