restfu接口文档模板.doc

完 美 ， 格 式 ， 编 辑 接口协议说明书 编 制 ： 审 核 ： 批 准 ： 姓 名 ： 姓 名 ： 姓 名 ： 部 门 ： 部 门 ： 部 门 ： 受控状态： 发 放 号 ： 2017-07-13发布2017-07-13实施 2017-07-13发布 专业.资料.整理 档 档 水印 版权说明 本文件中出现的任何文字叙述、文档格式、插图、照片、方法、过程等内容，除另有 特别注明，版权均属XXXX公司所有，受到有关产权及版权法保护。 原创力文 本文件将交付XX系统开发使用，使用范围仅局限于工程。本文件及其附录的知识产权归XXXX公司所有。如无授权，请勿复制或传播book118. 下 载 高 清 本文件将交付XX系统开发使用，使用范围仅局限于工程。 专业.资料.整理 完 美 ， 格 式 ， 编 辑 修订页 版本 章节名称 修订内容简述 修订日期 00 所有章节 创建 2017-08-16 原创力文档 下 载 高 清 无 水 印 专业.资料.整理 完美.格式.编辑 目 录 通信协议说明书 1 目 录 1 引言 5 1.1 Restful介绍 5 2 中心服务器与播放控制器间通信协议 5 2.1 概述 5 2.2 用户管理 5 2.2.1 登录 5 专业.资料.整理 完美 ， 格式 ， 编辑 1 引言 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 登 录 请求 API POST /api/vl/login 请求参数描述 Name In Type Description account body string User account password body string User password encryption 请求参数示例 { account :admin, password:md5(admin) } 回应状态码 状态码 描述 专业.资料.整理 原创力文档 下载高清无水印 完美.格式.编辑 200-0K 成功 401-Unauthorized 未授权 403-Forbidden 当前用户无权限 503-Service Unavailable 服务不可用 回应参数描述 Name In Type Description token body string Session token expired in body int 时效，单位秒 id body int 用户ID account body string 账号 name body string 名称 description body string 描述 status body int 用户状态0:禁用1:启用 update time body string 更新时间，格式：% Y%m%d%H%M%S functions body int[] 功能权限Id数组 回应参数示例 { token:69B3E86AEB5C278B5758B6F705E041C6, expired in: 60 , id:1, account:admin, name : 管 理 员 , description : , status : 1 update time :20160510121030, functions :[ 1, 2 1 专业.资料.整理