SparkAP的I开发指南.pdfVIP

Spark API 开发指南 Version: 1.1 Date: 2011-4-22 1. 概述 利用 Spark API 可以与 CC 视频 Spark 平台进行对接，使用 Spark 平台的主要视频功能。当 前 Spark API 的版本号为 1.0，具有上传、播放、获取视频信息、获取用户信息四个接口。 目前 Spark API 仅对合作方开启，如果你有使用的需求，请通过 CC 视频后台申请 API Key， 通过审核后才能使用 Spark API。 2. 通信约定 Spark API 的远程通信接口基于 Http 协议，有以下约定： 2.1 Http Method 所有的 Http 通信接口都采用 GET 的请求方式。 2.2 返回格式 所有的 Http 通信接口都以 XML 格式返回 UTF-8 编码的结果。对于不同的接口，正确的返回结 果的格式会在每个接口中单独定义，错误的返回结果具有统一的形式，即以 XML 格式返回一个错误码。 ?xml version=1.0 encoding=UTF-8? errorSERVICE_EXPIRED/error 错误码 含义 INVALID_REQUEST 用户输入参数错误 SPACE_NOT_ENOUGH 用户剩余空间不足 SERVICE_EXPIRED 用户服务已过期 PROCESS_FAIL 服务器处理失败 TOO_MANY_REQUEST 访问过于频繁 PERMISSION_DENY 用户服务被封禁 2.3 编码格式 Spark API 只接受 UTF-8 格式编码的信息，返回的 XML 也都是 UTF-8 编码的。 URL 的 QueryString 里面的 value 值都需要进行 URL Encode 之后，再进行传递。 第 1 页 共 7 页 2.4 通信加密方式 所有的 Http 通信都是加密的，加密的核心是将原始的 QueryString 转换为和请求时间相关的 HashedQueryString，我们称这个加密算法为 THQS 算法。关于 THQS 算法的细节请参见附录 1. 2.5 接口访问次数限制 Spark 平台规定，每个接口的访问次数每分钟不得超过 100 次。 开发者可以在 CC 视频后台 API 管理页面查看各个接口的访问情况。当某一个接口的访问频率过大 的时候，该用户的 API 功能将被禁用，之后所有请求都将失效。如果上述阈值无法满足你的正常需求的 时候，可以联系 CC 客服申请提升 API 的请求频率。 3. 接口明细 3.1 上传视频 在上传视频中，不用与 Spark 平台进行 Http 通信，使用 javascript 和 Spark 提供的 flash 进行交互即可完成。关于如何在网页中嵌入 flash 以及如何和 flash 进行交互，请参阅附录 2。上传接 口用到的所有 javascript 函数签名见下表： 函数签名 参数含义 on_spark_selected_file(file_name, file_size) file_name: 上传文件名