春雨云 OpenApi 开放接口文档 概述
春雨云开放API,为开发者提供直播流生命周期管理、账号配额查询能力,所有接口均采用统一签名鉴权,简单可靠,便于接入业务系统。
所有用户在使用开放API前必须进行实名认证(个人/企业),认证成功后申请开放。
接口总览
| 接口名称 |
接口地址 |
功能说明 |
| 创建直播流地址 |
AddLiveStreamUrl.ashx |
新建一条推拉流地址 |
| 回收直播流地址 |
RecycleLiveStreamUrl.ashx |
回收流,回收即禁流,强制过期 |
| 获取直播流地址列表 |
GetLiveStreamList |
查询账号下全部流列表 |
| 获取在线直播流地址列表 |
GetOnLineLiveStreamList |
查询当前正在推流的在线流 |
| 查询直播流状态 |
QueryLiveStreamStatus |
单独获取一条流的在线/禁用状态 |
| 查询单条流完整详情 |
GetLiveStreamDetail |
获取单条流全部信息 |
| 禁用直播流 |
DisabledLiveStream |
手动禁用一条流,推流会断开 |
| 恢复直播流 |
RestoreLiveStream |
将已禁用的流恢复可用 |
| 获取账户配额信息 |
GetAccountQuotaInfo |
查询账号剩余流量、时长、Y币配额等 |
公共请求约定
| 项目 |
说明 |
| 请求方式 |
POST,表单Form提交 |
| 鉴权算法 |
HMAC-SHA256 |
| 数据编码 |
UTF-8 |
| 返回格式 |
JSON |
| 操作限制 |
所有接口仅支持单条流操作,不支持批量 |
| 请求现在 |
所有接口单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。 |
公共鉴权参数(所有接口必传)
| 参数名 |
是否必填 |
说明 |
| openapi_key |
是 |
开放密钥 AccessKey,后台分配 |
| Timestamp |
是 |
Unix秒级时间戳,服务端校验时差,防止重放攻击 |
| Nonce |
是 |
随机字符串(Guid推荐),防止重放攻击 |
| Signature |
是 |
HMAC-SHA256签名结果,签名原文:按字典升序拼接【openapi_key、Timestamp、Nonce + 当前接口业务参数】,使用openapi_secret作为密钥加密 |
公共返回结构(不带数据)
{
"code": 0,
"msg": "success"
}
公共返回结构(带数据)
{
"code": 0,
"msg": "success",
"data":[]
}
公共错误码
| code |
说明 |
| 401 |
缺少鉴权参数 |
| 402 |
时间戳格式非法 |
| 403 |
请求超时,拦截重放请求 |
| 404 |
账号状态已锁定 |
| 405 |
账号无API请求权限 |
| 406 |
账号未认证 |
| 407 |
openapi_key不可用 |
| 408 |
签名校验失败 |
重要注意事项:
1. RecycleLiveStreamUrl 回收接口,一旦调用即执行禁流,流地址直接强制过期,无法继续推流播放;
2. 签名计算时,参数需要按字典序升序排序后拼接,中文参数值参与签名;
3. Secret(openapi_secret)严禁在前端、客户端明文存放,仅用于后端计算签名;
4. 时间戳允许误差范围:±300秒,超出判定为非法请求;
5. 接口限流:高频查询类接口请勿短时间密集请求,遇到503可适当间隔重试。