# 接口规范

# 调用方式

请求方式:GET

请求地址

接入类型 请求地址
接入点 https://api.yuewen.com/content/cp/ServiceBus.do?service=cpAudio

请求头:

说明 类型 必填 说明
Content-Type string application/x-www-form-urlencoded

请求和响应的字符集编码均为 UTF-8

# 请求通用参数

通用入参:以下参数在所有接口调用均需传入,各接口不再重复说明。

参数 类型 必填 说明
appKey string 接入方唯一标识,在阅文开放平台获取的 appKey
appToken int 请求token, 参考生成规则

# 通用返回字段

通用出参:以下参数在所有接口返回值中均存在,各接口不再重复说明。

参数 类型 说明 业务说明
returnCode int 返回码 业务状态码,0为成功,其它失败
returnMsg string 返回信息 业务状态码对应的信息
result object 返回内容 各接口返回对象

# appToken 生成规则

为了确保接口调用过程中的安全性,所有接口都需要携带 appToken,接口会根据请求参数,对签名进行验证,并拒绝签名不合法的请求,appToken 生成如下:

步骤 说明
1 取 appKey 的最后四位,后面加上 yyyyMMdd 格式的当日日期,组成字符串
2 用步骤 1 获取的字符串生成 MD5 值(32 位小写)
3 取生成的 MD5 值的前 12 位,即为 appToken

# 数据回传签名算法

为了确保接口调用过程中的安全性,数据回传 API 需要携带请求签名,接口会根据请求参数,对签名进行验证,并拒绝签名不合法的请求,签名过程如下: 备注:获取 appflag 与 appsecret(参考阅文开放平台接入指南

步骤 说明
1 本次调用接口请求参数的参数名(key)首字母以 ASCII 升序排列,首字母相同则从左往右使用下个字母,以此类推
2 排序后的结果按照参数名(key)参数值(value)进行拼接,不做任何编码,不添加其它字符(格式:key1value1key2value2…keyNvalueN)得到参数字符串 S1
3 在参数字符串 S1 头部拼接 appsecret,得到签名字符串 S2
4 对签名字符串 S2 使用 MD5 算法获取哈希值后转为大写,即为通用入参的 sign 值

各语言签名示例