接口鉴权说明

1. Base URL

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

https://aimatrix.yuntongxun.com/v1/

  

1.2. 统一请求包头

1.2.1. 业务URL格式：

/application/{appid}/{func}/{funcdes}?sig={SigParameter}
 
  • Base URL与业务URL相拼接为完整请求URL，其中{}内为可变参数。
  • url全部采用小写字母。
  • 参数func和funcdes根据接口填写；
  • 参数appid为应用ID，可从容联电话机器人后台创建获得；
  • 参数SigParameter做MD5加密后得到，参考后文的鉴权方式说明。
 

1.2.2. HTTP标准包头字段（必填）        

  • Content-Type:application/json;charset=utf-8; 
  • Content-Length:256; 
  • Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX  
  
变量说明：

属性

类型

约束

说明

appid

String

必选

应用ID。由32个英文字母和阿拉伯数字组成的唯一标识符

SigParameter

String

必选

验证参数，请求URL必须带有此参数，生成规则详见下方说明

Content-Type

String

必选

类型：application/json;charset=utf-8

Authorization

String

必选

验证信息，生成规则详见下方说明

func

String

可选

业务功能，根据业务的需要添加

funcdes

String

可选

业务操作，业务功能的各类具体操作分支

 

1.3. 鉴权方式说明

1.3.1. SigParameter是REST API 验证参数

  • URL后必须带有sig参数，例如：sig=AAABBBCCCDDDEEEFFFGGG。
  • 使用MD5加密（应用Id+应用授权令牌+时间戳）。其中应用Id和应用授权令牌分别对应管理控制台上应用详情中的 APP ID和APP TOKEN。
  • 时间戳是当前系统时间，格式"yyyyMMddHHmmss"。时间戳有效时间为24小时，如：20180416142030

1.3.2. Authorization是包头验证信息

  • 使用Base64编码（应用Id+冒号+时间戳）。
  • 冒号为英文冒号。
  • 时间戳是当前系统时间，格式"yyyyMMddHHmmss"，需与SigParameter中时间戳相同。

1.3.3. func描述业务功能 funcdes描述业务功能的具体操作

  • 比如：/aicall/dial