restfu接口文档模板.docxVIP

XXXX公司 接口协议说明书 实施日期：2017-08-16 文件名称：接口协议说明书 第 PAGE \* MERGEFORMAT 6页，共7页 文件编号：XX-PNXXXXX-RS-XXX 版本号：00 接口协议说明书 编制: 审核: 批准: 姓名： 部门： 姓名： 部门： 姓名： 部门： 受控状态： 发 放 号： 2017-07-13发布 2017-07-13实施 接口协议说明书 版权说明 本文件中出现的任何文字叙述、文档格式、插图、照片、方法、过程等内容，除另有特别注明，版权均属xxxx公司所有，受到有关产权及版权法保护。 本文件及其附录的知识产权归xxxx公司所有。如无授权，请勿复制或传播。 本文件将交付xx系统开发使用，使用范围仅局限于工程。 修订页 版本 章节名称 修订内容简述 修订日期 00 所有章节 创建 2017-08-16 目 录 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc493162887 通信协议说明书 PAGEREF _Toc493162887 \h 1 HYPERLINK \l _Toc493162888 目 录 PAGEREF _Toc493162888 \h 4 HYPERLINK \l _Toc493162889 1 引言 PAGEREF _Toc493162889 \h 5 HYPERLINK \l _Toc493162890 1.1 Restful介绍 PAGEREF _Toc493162890 \h 5 HYPERLINK \l _Toc493162891 2 中心服务器与播放控制器间通信协议 PAGEREF _Toc493162891 \h 5 HYPERLINK \l _Toc493162892 2.1 概述 PAGEREF _Toc493162892 \h 5 HYPERLINK \l _Toc493162893 2.2 用户管理 PAGEREF _Toc493162893 \h 5 HYPERLINK \l _Toc493162894 2.2.1 登录 PAGEREF _Toc493162894 \h 5 引言 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，使用非常方便。 中心服务器与播放控制器间通信协议 概述 云平台中心服务器与播放控制器间的通信采用restful通信协议框架，云平台作为restful服务器，播放控制器作为restful客户端。 登录 用户管理 登录 请求API POST /api/v1/login 请求参数描述 Name In Type Description account body string User account password body string User password encryption 请求参数示例 { account: admin, password: md5(admin) } 回应状态码 状态码 描述 200 - OK 成功 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 st