Restful接口规则(完整).docVIP

Restful接口设计规范 Restful简介 REST是“REpresentational State Transfer”的缩写，可以翻译成“表现状态转换”，但是在绝大多数场合中我们只说REST或者RESTful。为什么会起这么一个奇怪的名字呢？我们可以从上述这篇论文中找到答案。Fielding在论文中将REST定位为“分布式超媒体应用（Distributed Hypermedia System）”的架构风格，它在文中提到一个名为“HATEOAS（Hypermedia as the engine of application state）”的概念。 我们利用一个面向最终用户的Web应用来对这个概念进行简单阐述：这里所谓的应用状态（Application State）表示Web应用的客户端的状态，简单起见可以理解为会话状态。资源在浏览器中以超媒体的形式呈现，通过点击超媒体中的链接可以获取其它相关的资源或者对当前资源进行相应的处理，获取的资源或者针对资源处理的响应同样以超媒体的形式再次呈现在浏览器上。由此可见，超媒体成为了驱动客户端会话状态的转换的引擎。 借助于超媒体这种特殊的资源呈现方式，应用状态的转换体现为浏览器中呈现资源的转换。如果将超媒体进一步抽象成一般意义上的资源呈现（Representation ）方式，那么应用状态变成了可被呈现的状态（REpresentational State）。应用状态之间的转换就成了可被呈现的状态装换（REpresentational State Transfer），这就是REST。 服务地址： http://ip:端口/v2/userstatusrealsingle 提供用户状态信息实时查询 请求参数说明: 是否必须 默认值 格式举例 含义 appid 是 无 ‘100001’ 第三方应用唯一标示，由全网管理员在运营管理平台应用上线时分配 transid 是 无 ‘2014101615030000001’ 事务ID，每次加1，用于判断是否是重放攻击 ebid 是 无 2300000000000001 能力id，运管平台生成 token 是 无 E4805d16520de693a3fe707cdc962045 加密 msisdn 是 无 1064826000001 所查询专网号码 output 否 json json或xml 请求返回格式 示例： ebid=2300000000000001transid=2014101615030000001 token=E4805d16520de693a3fe707cdc962045msisdn=1064826000001 返回值： status : 0, message : ok, result : { status:’00’ } } 短信失败记录历史查询： 有LIST传递 待定 服务地址： http://ip:端口/v2/smsfaulthistory1 返回短信失败记录相应数据 请求参数说明: 是否必须 默认值 格式举例 含义 appid 是 无 ‘100001’ 第三方应用唯一标示，由全网管理员在运营管理平台应用上线时分配 transid 是 无 ‘2014101615030000001’ 事务ID，每次加1，用于判断是否是重放攻击 ebid 是 无 2300000000000001 能力id，运管平台生成 token 是 无 E4805d16520de693a3fe707cdc962045 加密 msisdn 是 无 1064826000001 所查询专网号码 output 否 json json或xml 请求返回格式 begin_time 是 无查询开始时间 查询时间范围：3个月内的记录 end_time 是 无查询结束时间 查询时间范围：3个月内的记录 page_size 否 10 10 返回记录数量，默认为10条记录，最大可设置为20条 page_num 否 0 0、1、2 分页页码，默认为0。 0代表第一页，1代表第二页，以此类推。 如果设置了此字段，则输出结果中含有total字段。 示例： 2300000000000001transid=2014101615030000001token=E4805d16520de693a3fe707cdc962045msisdn=1064826000001 begintimendtime返回值： status : 0, message : ok, result :[ { } ] } 用户实时位置信息查询 服务地址： http://ip:端口/v2/locationinfo