《国际影视中心云平台集成设计项目-云媒资接接口开发设计方案》由会员分享，可在线阅读，更多相关《国际影视中心云平台集成设计项目-云媒资接接口开发设计方案（96页珍藏版）》请在金锄头文库上搜索。
1、 国际影视中心云平台集成设计项目云媒资接接口开发设计方案云平台建设工作小组XX设计团队2015年7月18日版本更新说明版本修改备注V1整体框架设计V3添加内容资源访问接口定义添加业务接口的工单任务接口定义V4完成剩余接口定义目录标准服务接口文档1版本更新说明2目录31接口定义61.1通信协议61.2数据格式61.3编码格式71.4基础请求协议71.5基础响应协议71.6签名加密71.7接口日志81.8其它约定82平台管理资源接口92.1用户登陆92.2用户登出92.3用户登陆状态更新102.4获取用户信息112.5获取用户所有权限112.6获取模块权限132.7获取发布域权限132.8获取工作
2、组权限142.9获取用户分类权限152.10获取用户操作权限162.11获取token173内容资源访问接口183.1素材库183.1.1查找内容183.1.2添加文稿213.1.3修改文稿233.1.4删除文稿243.1.5添加图片243.1.6修改图片253.1.7删除图片263.1.8添加视频273.1.9修改视频293.1.10删除视频303.1.11添加音频313.1.12修改音频323.1.13删除音频333.2成品库343.2.1查找内容343.2.2添加文稿373.2.3修改文稿393.2.4删除文稿403.2.5添加图片403.2.6修改图片423.2.7删除图片433.2.
3、8添加视频433.2.9修改视频453.2.10删除视频473.2.11添加音频473.2.12修改音频493.2.13删除音频503.2.14添加包513.2.15修改包513.2.16删除包533.2.17关联包533.3内容检索543.3.1添加检索数据543.3.2更新检索数据553.3.3全文检索553.3.4视频检索573.3.5音频检索593.3.6图片检索623.3.7文稿检索643.3.8热门推荐663.3.9删除数据683.4汇聚区资源683.4.1获取收录频道683.4.2获取收录指定时段素材信息693.4.3获取收录频道下的素材信息703.4.4获取CP供应商目录713
4、.4.5获取CP供应商素材信息723.4.6获取CP上传数据列表733.4.7我的内容访问744业务管理资源访问接口754.1工单任务访问接口754.1.1获取工单列表754.1.2获取详细工单764.1.3获取任务列表774.1.4获取任务详细794.1.5认领任务804.2节目访问接口824.2.1新建节目824.2.2删除节目834.2.3修改节目834.2.4查询节目844.2.5提交节目854.2.6节目发布854.3审核访问接口864.3.1认领审核任务864.3.2获取审核打回任务864.3.3提交审核任务884.3.4获取我的审核任务885互联互通901 接口定义1.1 通信协
5、议接口采用RESTful的架构风格，REST是REpresentational State Transfer的简称，译为表述性状态转移，一个架构符合REST原则，就称它为RESTful架构。接口中协议的格式以ATOM（RFC 4287）及其JSON格式为基础，进行一定的属性扩展以便符合现有的业务应用的开发趋势。 几个重要的 REST 原则： 为所有“事物”定义资源 将所有事物链接在一起 使用标准方法 资源多重表述 无状态通信在这种架构中不需要过于复杂的数据结构，和方法抽取、业务逻辑接口定义，只需要根据不同的URL接口返回以JSON格式描述数据结构，这样能很好适应WEB应用中简单、快速的应用需求
6、，避免复杂的接口调用过程。约定：所有基于RESTFul的对象都看作是资源，有且只有”增、删、改、查”四个方法1.2 数据格式接口的数据交互支持 JSON数据格式，对于不同的接口，所返回的 JSON格式的数据会有所不同，详情请参考各接口的定义。JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。它基于ECMAScript的一个子集。 JSON采用完全独立于语言的文本格式，但是也使用了类似于C语言家族的习惯（包括C、C+、C#、Java、JavaScript、Perl、Python等）。这些特性使JSON成为理想的数据交换语言。 易于人阅读和编写，同时也易
7、于机器解析和生成(网络传输速率)。1.3 编码格式接口接受UTF-8编码格式的编码信息。传入的参数和返回的结果都是UTF-8格式的。UTF-8（8-bit Unicode Transformation Format）是一种针对Unicode的可变长度字符编码，又称万国码。由Ken Thompson于1992年创建。现在已经标准化为RFC 3629。UTF-8用1到6个字节编码UNICODE字符。用在网页上可以同一页面显示中文简体繁体及其它语言（如英文，日文，韩文）。1.4 基础请求协议序号字段描述备注1path接口命名路径如：/system/login2appKey各挂接应用标识符由系统进行分
8、配3sign/token签名或者令牌Sign算法详见签名加密4timestamp请求时间戳格式：14339147545data请求参数数据具体数据格式详见各个接口定义1.5 基础响应协议序号字段描述备注1code响应状态代码00001111，四位十进制字符串，不满四位用0填充。0000表示成功或正常，9999保留作为未知系统错误，其它由各个接口具体定义，每个接口从0001开始递增编号。2description响应状态说明3data响应参数数据具体数据格式详见各个接口定义1.6 签名加密接口调用方，都需要经过权限中心授权。授权完成后，调用方会收到appKey和appSecret 两个授权码。在每
9、次调用接口时，需要实现下列步骤（例：获取token。appKey为123456789，appSecret 为 c84425b7e9f61d2c7cb9626a137f64ae52f2b7c8）1. 根据接口所需参数构建请求数据namespace: /system/token,appKey: 123456789,timestamp: 1433914754,uid:102. 需要将调用接口的参数（不包括namespache,appkey,timestamp）按照参数名进行升序排列，然后将参数名与参数值拼接为字符串uid103. 拼接appSecret然后MD5编码md5(uid10c84425b7
10、e9f61d2c7cb9626a137f64ae52f2b7c8)4. 将得到的编码值赋予sign变量，然后组成parameter参数的值parameter=namespace: /system/token,appKey: 123456789,timestamp: 1433914754,uid:10，sign： 54e4836d7715525abeead96ba3c2f00e1.7 接口日志接口请求和接收方都需要记录发送和接收日志，用以日后进行查询、对账使用。1.8 其它约定接口参数区分大小写。严禁使用测试接口地址，做线上业务应用。2 平台管理资源接口2.1 用户登陆通过账号密码进行登陆验证，
11、系统根据设置判断是否做单点登陆验证。密码不做明文传输。请求协议 HTTP method：GET序号字段值描述1namespace/system/auth接口命名2appKey系统分配各挂接应用标识符3sign加密签名签名4timestamp时间戳请求时间戳5data account: test,account：账号名称该接口需要将密码（password）做MD5后，作为签名的普通参数一并进行加密生成签名进行传输，而在接口的data参数里面不再明文传输密码。响应协议序号字段值描述1code00000001000200030004响应状态代码2description登陆成功账号不存在密码与账号不匹
12、配该账号已登陆签名已过期响应状态说明3data uid: 312,如果登陆成功则返回uid，否则返回空。uid：用户id2.2 用户登出请求协议 HTTP method：DELETE序号字段值描述1namespace/system/auth接口命名2appKey系统分配各挂接应用标识符3sign加密签名签名4timestamp时间戳请求时间戳5data uid: 312uid：用户id响应协议序号字段值描述1code000000010002响应状态代码2description登出成功登出失败签名已过期响应状态说明3data返回空2.3 用户登陆状态更新请求协议 HTTP method：PUT序号字段值描述1namespace/system/auth接口命名2appKey系统分配各挂接应用标识符3sign加密签名签名4timestamp时间戳请求时间戳5data uid: 312uid：用户id响应协议序号字段值描述1code000000010002响应状态代码2description更新登陆状态成功更新登陆状态失败签名已过期响应状态说明3data返回空2.4 获取用户信息请求协议 HTTP method：GET序号字段值描述1namespace/system/user/info接口命名2appKey系统分配各挂接应用标识符3sign加密签名签名4timestamp时间戳
