restfu接口文档模板.docx

接口协议说明书编制:审核:批准: 姓名： 部门： 姓名： 部门： 姓名： 部门： 受控状态： 发 放 号：2017-07-13发布 2017-07-13实施版权说明本文件中出现的任何文字叙述、文档格式、插图、照片、方法、过程等内容，除另有特别注明，版权均属XXXX公司所有，受到有关产权及版权法保护。本文件及其附录的知识产权归XXXX公司所有。如无授权，请勿复制或传播。本文件将交付XX系统开发使用，使用范围仅局限于工程。修订页版本章节名称修订内容简述修订日期00所有章节创建2017-08-16目 录通信协议说明书1目 录41引言51.1Restful介绍52中心服务器与播放控制器间通信协议52.1概述52.2用户管理52.2.1登录51 引言1.1 Restful介绍REpresentational State Transfer (REST) 是一种架构原则，其中将 web 服务视为资源，可以由其 URL 唯一标识。RESTful Web 服务的关键特点是明确使用 HTTP 方法来表示不同的操作的调用。 REST 的基本设计原则对典型 CRUD 操作使用 HTTP 协议方法： POST - 创建资源 GET - 检索资源 PUT 更新资源 DELETE - 删除资源.REST 服务的主要优势在于： 它们是跨平台 (Java、.net、PHP 等）高度可重用的，因为它们都依赖基本 HTTP 协议。 它们使用基本的 XML/JSON，而不是复杂的 SOAP XML，使用非常方便。2 中心服务器与播放控制器间通信协议2.1 概述云平台中心服务器与播放控制器间的通信采用restful通信协议框架，云平台作为restful服务器，播放控制器作为restful客户端。登录2.2 用户管理2.2.1 登录 请求APIPOST /api/v1/login 请求参数描述NameInTypeDescriptionaccountbodystringUser accountpasswordbodystringUser password encryption 请求参数示例 account: admin, password: md5(admin) 回应状态码状态码描述200 - OK成功401- Unauthorized未授权403 - Forbidden当前用户无权限503 - Service Unavailable服务不可用 回应参数描述NameInTypeDescriptiontokenbodystringSession tokenexpired_inbodyint时效，单位秒idbodyint用户IDaccountbodystring账号namebodystring名称descriptionbodystring描述statusbodyint用户状态0:禁用 1：启用update_timebodystring更新时间，格式:”%Y%m%d %H%M%S”functionsbodyint功能权限Id数组 回应参数示例token: 69B3E86AEB5C278B5758B6F705E041C6,expired_in: 60,id: 1,account: admin,name