一、更新历史

版本	说明	author	时间
1.0	创建,从api/v1更新. 添加v2/customers.json参数说明	韦昭	20150915

二、签名生成总体说明

说明: 与v1版本基本不变

Step 1. 构造源串

源串是由请求参数和企业的secret用"&"拼接起来的: key1=value1&key2=value2&secret. 源串构造步骤如下:

• 第1步：将除"sign"外的所有参数按key进行字典升序排列。 注：除非API文档中特别标注了某参数不参与签名，否则除sign外的所有参数都要参与签名.
• 第2步：将第1步中排序后的参数(key=value)用&拼接起来。

源串构造示例如下（由于是通用说明，这里以/api/v1/tickets.json作为示例，且示例中的请求串不可直接复制访问。）

1. 请求参数：page=1&per_page=10
2. 安全校验码(安全校验码即单点登录中的共享秘钥): 99d80d18b0b9a994a8d0283e830e5099
3. 构造源串：
   • 第1步：将除"sign"外的所有参数按key进行字典升序排列，排列结果为：page,per_page
   • 第2步：将第1步中排序后的参数(key=value)用&拼接起来：page=1&per_page=10
   • 第3步：把拼接后的字符串再与安全校验码直接连接, 则源串为：page=1&per_page=10&99d80d18b0b9a994a8d0283e830e5099

Step 2. 生成签名值

获得源串签名结果sign=md5("page=1&per_page=10&99d80d18b0b9a994a8d0283e830e5099") 假设得到的签名值结果如下：b48d4134e7d13839b09b5423e300c352

Step 3. 最终请求地址

http://yourdomain.udesk.cn/api/v2/tickets.json?page=1&per_page=10&sign=b48d4134e7d13839b09b5423e300c352

三、API调用示例

1、获取工单列表:

http://yourdomain.udesk.cn/api/v1/tickets.json?page=1&per_page=10&sign=b48d4134e7d13839b09b5423e300c352

请求参数说明：

yourdomain 公司的二级域名
page 请求当前分页，默认是1
per_page 每页返回的数目，默认是20

返回结果说明:

参数名称	说明
status	返回码。0:执行成功，1001:指定的id不存在, 2001:二级域名有错误, 2002:生成的sign错误
message	如果错误，返回错误信息。
size	当前返回的条数
total	数据记录的总条数
contents	返回的数据（工单列表按时间顺序从旧到新排序）
id	工单ID编号
subject	工单标题
content	工单内容
platform	工单渠道
priority	工单优先级
created_at	工单创建时间
updated_at	工单更新时间
content_type	工单内容的类型
status	工单状态
user	工单提交人
assignee	受理客服人员

返回示例:

{
    "status":0,
    "message":"成功",
    "size":20,"total":20,
    "contents":[
        {"id":1,"subject":"聚美优品是正品吗？","content":"是！","platform":"邮件","priority":"高","created_at":"2014-12-06 13:07:16 +0800","updated_at":"2014-12-06 15:14:29 +0800","content_type":"html","status":"open","user":"Lucy","assignee":"Tom"}
     ]
}

错误返回示例：

``` {"status":2002,"message":"生成的sign错误"}