Udesk API v1 使用介绍(一)

作者:张振琦

之前写了API v2的使用介绍,发现API v1的接口也可能会用到,那就把这块也补上来。现在就来看看API v1 是如何使用的。

Udesk 开放接口(v1)的调用地址符合以下格式:
https://[子域名].udesk.cn/api/[版本]/[接口相对地址]?[Query String]&sign=[签名]

变量 说明
子域名 您使用 Udesk 客服系统时,分配给您的子域名
版本 接口的版本。Udesk 开放接口(v1)有过一次小的升级,所以该值可能是 v1 或 v2,分别代表1.1版和1.2版
接口相对地址 接口的相对地址
Query String 地址的参数部分,该部分要参与签名计算
签名 身份验证签名

API v1的URL参数比API v2的要简单简单一些,除了服务必须的参数,就只需添加一个签名。API v1 所有接口调用需要携带签名参数 sign,只有当 sign 值合法时请求才会被接受。

sign 的计算方法如下:
sign=MD5(QueryString + “&” + Secret)
其中:
1.QueryString 为URL中的参数(不包含参数 sign),格式为“&”分割的“key=value”字符串,顺序为参数在调用地址中的顺序;
2.Secret 为单点登录共享秘钥,您可以在网站后台【管理中心】->【管理】->【单点登录】中找到。
3.当 QueryString 为空时,“sign=MD5(Secret)”,因此 V1 版本的接口存在安全隐患,所以我们建议您尽量采用新版接口; 如果某些参数没有 value,需要组合为“key=key”的形式。

从计算方法中可以看出来,服务请求的URL参数参与了签名的计算,采用MD5算法加密。Secret可以从在线客服系统终获取,位置如下:
Udesk API v1 使用介绍(一)
整理一下,调用API v1需要做的事情:

  1. 管理员登陆在线客服系统获取 Secret。
  2. 查询需要调用的API接口说明,拼接URL参数
  3. 使用URL参数和Secret,通过MD5加密方式,得到sign。
  4. 在原有的URL参数后面加上签名sign。

后续将介绍使用Java调用Udesk API v1的代码实现过程。Udesk官网APIv1介绍地址:https://www.udesk.cn/doc/apiv1/intro/