restfu接口文档模板

XXXX公司接口协议说明书接口协议说明书

受控状态：

发放号：

2017-07-13发布2017-07-13实施

版权说明

修订页

目录

通信协议说明书 (1)

目录 (4)

1引言 (5)

1.1Restful介绍 (5)

2中心服务器与播放控制器间通信协议 (5)

2.1概述 (5)

2.2用户管理 (5)

2.2.1登录 (5)

1引言

1.1Restful介绍

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登录

2.2.1.1请求API

POST /api/v1/login

2.2.1.2请求参数描述

2.2.1.3请求参数示例

{

"account": "admin",

"password": "md5(admin)"

}

2.2.1.4回应状态码

2.2.1.5回应参数描述

2.2.1.6回应参数示例

{

"token": "69B3E86AEB5C278B5758B6F705E041C6", "expired_in":60,

"id":1,

"account": "admin",

"name": "管理员",

"description": "",

"status":1,

"update_time": "20160510 121030",

"functions":[

1,

2

]

}