restfu接口文档模板_第1页
restfu接口文档模板_第2页
restfu接口文档模板_第3页
restfu接口文档模板_第4页
restfu接口文档模板_第5页
全文预览已结束

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

-.z接口协议说明书编制:审核:批准::部门::部门::部门:受控状态:发放号:2021-07-13发布2021-07-13实施-.z说明本文件中出现的任何文字表达、文档格式、插图、照片、方法、过程等容,除另有特别注明,均属****公司所有,受到有关产权及法保护。本文件及其附录的知识产权归****公司所有。如无授权,请勿复制或传播。本文件将交付**系统开发使用,使用围仅局限于工程。修订页版本章节名称修订容简述修订日期00所有章节创立2021-08-16-.z目录通信协议说明书1目录21引言21.1Restful介绍22中心效劳器与播放控制器间通信协议22.1概述22.2用户管理2登录2-.z引言Restful介绍REpresentationalStateTransfer(REST)是一种架构原则,其中将web效劳视为资源,可以由其URL唯一标识。RESTfulWeb效劳的关键特点是明确使用HTTP方法来表示不同的操作的调用。REST的根本设计原则对典型CRUD操作使用HTTP协议方法:POST-创立资源GET-检索资源PUT–更新资源DELETE-删除资源.REST效劳的主要优势在于:它们是跨平台(Java、.net、PHP等〕高度可重用的,因为它们都依赖根本HTTP协议。它们使用根本的*ML/JSON,而不是复杂的SOAP*ML,使用非常方便。中心效劳器与播放控制器间通信协议概述云平台中心效劳器与播放控制器间的通信采用restful通信协议框架,云平台作为restful效劳器,播放控制器作为restful客户端。登录用户管理登录请求APIPOST/api/v1/login请求参数描述NameInTypeDescriptionaccountbodystringUseraccountpasswordbodystringUserpasswordencryption请求参数例如{"account":"admin","password":"md5(admin)"}回应状态码状态码描述200-OK成功401-Unauthorized未授权403-Forbidden当前用户无权限503-ServiceUnavailable效劳不可用回应参数描述NameInTypeDescriptiontokenbodystringSessiontokene*pired_inbodyint时效,单位秒idbodyint用户IDaccountbodystring账号namebodystring名称descriptionbodystring描述statusbodyint用户状态0:禁用1:启用update_timebodystring更新时间,格式:〞%Y%m%d%H%M%S〞functionsbodyint[]功能权限Id数组回应参数例如{"token":"69B3E86AEB5C278B5758B6F705E041C6","e*pired_in":60,"id":1,"acc

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论