接口鉴权说明

1、Base URL

文档中所有被引用的地址都有如下Base URL：

https://imapp.yuntongxun.com:8883/2013-12-26 

注意： 为了确保数据隐私，云通讯平台的REST API是通过HTTPS方式请求。

2、统一请求包头

业务URL格式：
  • Base URL与业务URL相拼接为完整请求URL，其中{}内为可变参数。
  • 参数func和funcdes根据接口填写；
  • 参数appId为应用ID，可从官网创建获得；
  • 参数SigParameter根据不同鉴权方式，做MD5加密后得到，参考后文的鉴权方式说明。
应用鉴权URL：
  • /Application/{appId}/{func}/{funcdes}?sig={SigParameter}
 
例如：
以应用鉴权的服务器端推送接口为例完整的URL为：
https://imapp.yuntongxun.com:8883/2013-12-26/Application/{appId}/IM/PushMsg?sig={SigParameter}
HTTP标准包头字段（必填）        
  • Accept:application/json;
    • 

  • Content-Type:application/json;charset=utf-8; 
    • 

  • Content-Length:256; 
    • 

  • Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX       
属性说明
属性
类型约束说明
appId String 必选 应用ID。由32个英文字母和阿拉伯数字组成的唯一标识符
SigParameter String 必选 验证参数，请求URL必须带有此参数，生成规则详见下方说明
Accept String 必选 客户端响应接收数据格式：application/xml、application/json
Content-Type String 必选 类型：application/json;charset=utf-8
Authorization String 必选 验证信息，生成规则详见下方说明
func String 可选 业务功能，根据业务的需要添加
funcdes String 可选 业务操作，业务功能的各类具体操作分支

3、应用鉴权方式

1. SigParameter是REST API 验证参数
•  URL后必须带有sig参数，例如：sig=AAABBBCCCDDDEEEFFFGGG。
•  使用MD5加密（应用Id + 应用授权令牌 +时间戳）。其中应用Id和应用授权令牌分别对应管理控制台上应用详情中的 APP ID和APP TOKEN。
•  时间戳是当前系统时间，格式"yyyyMMddHHmmss"。时间戳有效时间为24小时，如：20140416142030
2. Authorization是包头验证信息
•  使用Base64编码（应用Id+ 冒号 + 时间戳）
•  冒号为英文冒号
•  时间戳是当前系统时间，格式"yyyyMMddHHmmss"，需与SigParameter中时间戳相同。
3. func描述业务功能 funcdes描述业务功能的具体操作
• 例如：/IM/createChatRoom