平台说明
优质
小牛编辑
137浏览
2023-12-01
利用Spark API 可以与获得场景视频Spark云进行对接，使用Spark云的主要视频功能。当前Spark API的版本具有上传、播放、获取视频信息、获取用户信息、删除视频、获取视频、获取视频分类等接口。 目前Spark API仅对合作方开启，如果您有使用的需求，请通过获得场景视频后台申请API Key，通过审核后才能使用Spark API。
Spark API的远程通信接口基于HTTP协议，并有以下约定：
2.1 HTTP方法 所有接口采用GET请求。
2.2返回格式
接口的返回格式包括XML格式和JSON格式，编码均为UTF-8。对于不同的接口，正确返回接口的格式会在每个接口中单独定义，错误的返回结果具有统一的形式，如下所示：
<?xmlversion="1.0"encoding="UTF-8"?>
<error>ERROR_CODE</error>
{
"error":"ERROR_CODE"
}
实际中，下表中的某一个具体的错误码会替换掉上面的ERROR_CODE：
| 错误码 | 说明 |
|---|---|
| INVALID_REQUEST | 用户输入参数错误 |
| SPACE_NOT_ENOUGH | 用户剩余空间不足 |
| SERVICE_EXPIRED | 用户服务已经过期 |
| PROCESS_FAIL | 服务器处理失败 |
| TOO_MANY_REQUEST | 访问过于频繁 |
| PERMISSION_DENY | 用户服务无权限 |
2.3 编码格式
Spark API 只接受UTF-8 格式编码的信息，返回的数据也都是UTF-8 编码的。当需要通过GET 请求传递参数时，QueryString 里面的value 值都需要进行URL Encode 之后，再进行传递。
2.4加密
所有的 HTTP 通信都是加密的，加密的核心思想是将原始的QueryString 转换为和请求时间相关的HashedQueryString，我们称这个加密算法为THQS 算法。关于THQS 算法的细节请参见附录 1。
2.5 接口访问次数限制
当某一个接口的访问频率在一分钟之内超过100次的时候，该用户的API 功能将被禁用，之后所有请求都将失效。如果上述阈值无法满足您的正常需求的时候，可以联系 CC 客服申请提升API 的请求频率。