APP接口开发规范方案文档-V

{APP接口 规范 编程规范下载gsp规范下载钢格栅规范下载警徽规范下载建设厅规范下载 文档}手机客户端接口文档文件状态：文件标识：[]草稿当前版本：1.0[√]正式发布作者：Stone[]正在修改完成日期：.版本历史版本/状态作者参与者起止日期备注V1.0/草稿Stone移动小组.目录一、概述11.1有关接口1接口是纯数据的交互11.2接口的分类1查询类接口1操作类接口1上传下载类接口11.2.4推送类接口1二、查询类接口格式规范12.1获取单条对象信息1请求格式12.1.2参数说明22.1.3正常返回结果22.2获取列 表 关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf 对象信息22.2.1请求格式22.2.2参数说明32.2.3正常返回结果3三、操作类接口43.1新增操作43.1.1接口说明43.1.2参数说明43.1.3正常返回结果43.1.4错误返回列表43.2修改操作43.2.1接口说明43.2.2参数说明53.2.3正常返回结果53.2.4错误返回列表53.3删除操作53.3.1接口说明53.3.2参数说明53.3.3正常返回结果53.3.4错误返回列表6四、上传下载类64.1上传文件64.1.1接口说明64.1.2参数说明64.1.3正常返回结果64.1.4错误返回列表74.2下载文件74.2.1接口说明74.2.2参数说明7.4.2.3正常返回结果74.2.4错误返回列表7五、推送类接口75.1推送消息75.1.1接口说明75.1.2参数说明85.1.3正常返回结果85.1.4错误返回列表8六、通用返回格式86.1正确返回86.1.1接口说明86.1.2参数说明86.1.3正常返回结果86.1.4错误返回列表96.2错误返回96.2.1接口说明96.2.2参数说明96.2.3正常返回结果96.2.4错误返回列表9七、附录107.1通用错误返回列表107.2URL地址信息107.2.1主机地址107.2.2URL列表107.3安全机制107.3.1验证签名机制107.4其他107.2.1列表数据为空的返回10.一、概述1.1有关接口1.1.1接口是纯数据的交互APP接口是移动设备和业务之间进行通信的途径.实质就是以特定的规则通过接口直接操作数据库的增删改查.1.2接口的分类查询类接口查询类接口是指客户端传递一些参数,服务端根据参数依据需求,前往数据库查询需要的结果返回数据的一类接口.返回类型一般有两种.第一种是返回一个对象,第二种是返回一个数组对象.第一种比如登陆,客户端把用户名密码上传到接口,服务器返回用户的个人信息.第二种比如获取客户,客户端把用户的身份信息上传到接口,服务器返回此身份下的所有客户数组集合.操作类接口操作类接口是指,客户端通过接口进行一些增删改的操作.比如新增一个客户,修改客户信息,或者删除一个客户.服务器一般返回执行的状态,有的需要返回执行结果的一些信息,比如新增客户后,返回客户的ID.上传下载类接口上传下载类接口是涉及到文件传输的接口.比如上传头像,需要上传图片到服务器,服务端根据需求响应保存并返回结果.比如客户端需要显示用户头像,需要读取网络图片文件,在手机上进行显示.1.2.4推送类接口除了客户端主动去请求服务端,获取需要信息之外.有时候,也存在服务端有消息需要 通知 关于发布提成方案的通知关于xx通知关于成立公司筹建组的通知关于红头文件的使用公开通知关于计发全勤奖的通知 客户端的情况,这时候就是服务端向客户端发送消息.这类需求可以通过客户端短时间类循环请求解决,也可以通过第三方专业推送解决.也可以通过自己使用socket或者xmpp等协议进行开发.二、查询类接口格式规范2.1获取单条对象信息请求格式URL支持格式JOSN请求方式POST是否登录验证请求数限制.2.1.2参数说明参数名必选类型及范围说明xxxtrueString用户名2.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ok结果成功,fail结果失败ResponseObject响应体Key1int响应字段值Key2String响应字段值Key3Object响应字段值可以依然包含对象体Key3_Key1int响应字段值{"result":"ok","Response":{"userName":"Mary","sex":1,"Address":[{"city":"JiNan"},{"county":"LiXia"}]}}2.1.4错误返回列表详见：通用错误返回列表2.2获取列表对象信息2.2.1请求格式URL支持格式JOSN请求方式POST是否登录验证请求数限制.2.2.2参数说明参数名必选类型及范围说明xxxtrueString用户名Pagefalsint第几页,不传递默认第一页eSizefalsint一页多少条,不传递默认20条e2.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体LastUpdateTimeString最后一条更新时间根据此时间判断新旧ThisPageNumberint当前页条数判断是否为空,是否有下页DataListArray[Object]对象列表时间倒序排列{"result":"ok","Response":{"LastUpdateTime":"2012-12-1122:01:09","ThisPageNumber":2,"DataList":[{"id":1,"date":"2014-07-24","points":50},{"id":2,"date":"2014-07-24","points":50}]}}2.2.4错误返回列表详见：通用错误返回列表.三、操作类接口3.1新增操作3.1.1接口说明URL支持格式JOSN请求方式POST是否登录验证请求数限制3.1.2参数说明参数名必选类型及范围说明xxxtrueString用户名xxxtrueStringxxxtrueStringxxxtrueString3.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体idint增数据的ID或者标志textString操作提示语如添加客户成功,可为空{"result":"ok","Response":{"id":1,"text":""}}3.1.4错误返回列表详见：通用错误返回列表3.2修改操作3.2.1接口说明URL支持格式JOSN请求方式POST是否登录验证请求数限制.3.2.2参数说明参数名必选类型及范围说明xxxtrueString用户名xxxtrueStringxxxtrueStringxxxtrueString3.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体idint数据的ID或者标志textString操作提示语如修改客户成功,可为空{"result":"ok","Response":{"id":1,"text":""}}3.2.4错误返回列表详见：通用错误返回列表3.3删除操作3.3.1接口说明URL支持格式JOSN请求方式POST是否登录验证请求数限制3.3.2参数说明参数名必选类型及范围说明xxxtrueString用户名xxxtrueString3.3.3正常返回结果返回键类型返回值说明.resultString结果代码信号ResponseObject响应体idint数据的ID或者标志textString操作提示语如删除客户成功,可为空{"result":"ok","Response":{"id":1,"text":"亲,删除客户成功"}}3.3.4错误返回列表详见：通用错误返回列表四、上传下载类4.1上传文件4.1.1接口说明URL支持格式JOSN请求方式POST是否登录验证请求数限制4.1.2参数说明参数名必选类型及范围说明xxxtrueString用户名xxxtrueFile值为文件类型,处理同Web中的表单FILE一样4.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体filePathString文件存放的绝对路径上传{"result":"ok","Response":{"filePath":"://baidu/logo.gif".}}4.1.4错误返回列表详见：通用错误返回列表4.2下载文件4.2.1接口说明URL支持格式JOSN请求方式POST是否登录验证请求数限制4.2.2参数说明参数名必选类型及范围说明xxxtrueString文件网络绝对路径4.2.3正常返回结果返回键类型返回值说明确保文件可以正常访问下载4.2.4错误返回列表详见：通用错误返回列表五、推送类接口5.1推送消息5.1.1接口说明URL支持格式JOSN请求方式POST是否登录验证请求数限制.5.1.2参数说明参数名必选类型及范围说明5.1.3正常返回结果返回键类型返回值说明5.1.4错误返回列表详见：通用错误返回列表六、通用返回格式6.1正确返回6.1.1接口说明URL支持格式JOSN请求方式POST是否登录验证请求数限制6.1.2参数说明参数名必选类型及范围说明xxxtrueString用户名6.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体.{"result":"ok","Response":{}}6.1.4错误返回列表详见：通用错误返回列表6.2错误返回6.2.1接口说明URL支持格式JOSN请求方式POST是否登录验证请求数限制6.2.2参数说明参数名必选类型及范围说明xxxtrueString用户名6.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体errorTextString错误信息{"result":"fail","Response":{"errorCode":-998,"errorText":"用户名密码错误"}}6.2.4错误返回列表详见：通用错误返回列表.七、附录7.1通用错误返回列表errorCode表示说明-999通用错误只用于一处,或者无关紧要的提示性,错误-998用户名密码错误-997用户登陆超时或别处登录7.2URL地址信息7.2.1主机地址LocalHost正式地址：LocalHost测试地址：7.2.2URL列表URL描述备注API/login用户登录无需验证7.3安全机制7.3.1验证签名机制生成Token7.4其他7.2.1列表数据为空的返回列表数据为空时显示"DataList":[].