接口地址:https://open.wikeyun.cn/#/apiDocument/32/document/550

接口开发流程:
微客云集开放平台开放API基于http协议实现接口调用,已入驻开放平台开发者(ISV)可以按如下步骤实现请求,完成接口调用,以下调用指南针对开发者自行实现API调用,如您需要快速接入,可使用SDK快速实现,详情可参考SDK调用指南。
调用流程
微客云集开放平台API调用过程有以下步骤:
-
参数准备:了解您所要调用的API入参业务参数及系统参数
-
签名准备:系统参数sign(签名)的生成,需要使用所有参数参与签名过程
-
入参组装:组装入参请求结构体,完成请求前置所有动作
-
发起请求:发起API请求至指定接口地址
-
解析请求:对返回结构体进行解析,完成调用过程
(微客云集开放平台API调用流程示意图)

请求地址
所有开放平台开放API请求地址统一为:
|------|---------------------------|----------------------------|
| 环境 | http地址(已不允许调用) | https地址 |
| 正式环境 | http://router.wikeyun.cn/ | https://router.wikeyun.cn/ |
公共参数
公共参数是指调用任何微客云开放平台API均必须传入的参数,目前公共参数有以下:
|-----------|--------|------|---------------------------------|
| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| app_key | string | 是 | 已创建成功的应用标志appkey,可在应用详情和中查看 |
| timestamp | string | 是 | 时间戳,格式为UNIX时间(秒) |
| sign | string | 是 | API入参参数签名,签名值根据如下算法给出计算过程 |
| format | string | 是 | 请求返回的数据格式,可选参数为XML或JSON,默认为JSON |
| client | string | 是 | 请求客户端IP |
| v | string | 是 | API版本,默认为1.0 |
公共参数的传递需要使用get传递,即把系统参数拼接至最终url内。
业务参数
API调用除了必须包含公共参数外,如果API本身有业务级的参数也必须传入,各个API的业务级参数请考API文档详细描述说明。
业务参数的传递需要使用post传递。
签名算法
为了防止API调用过程中被恶意篡改,调用任何一个API都需要携带请求签名,开放平台服务端会根据请求参数,对签名进行验证,并对签名不合法的请求将会被拒绝。
目前支持的签名算法为:MD5(sign_method=md5),签名过程如下:
-
本次请求中所有请求参数(包含公共参数与业务参数)进行首字母以ASCII方式升序排列(ASCII ASC),对于相同字母则使用下个字母做二次排序,字母序为从左到右,以此类推
-
排序后的结果按照参数名(key)参数值(value)的次序进行字符串拼接,拼接处不包含任何字符
-
拼接完成的字符串做进一步拼接成1个字符串(包含所有kv字符串的长串),并在该长串的头部及尾部分别拼接appSecret,完成签名字符串的组装
-
最后对签名字符串,使用MD5算法加密后,得到的MD5加密密文后转为大写,即为sign值
注意:若value为array/list时,value请勿拼接,只保留key即可。