APP接口开发规档.docVIP

APP接口开发标准文档. APP接口开发标准文档. APP接口开发标准文档. APP接口标准文档 {北京天晴APP接口标准文档} 客户端接口文档 文件状态：文件表记： []底稿目前版本： [√]正式宣告 作者：北京天晴 []正在改正 达成日期： APP接口标准文档 版本历史 版本/状态作者参加者起止日期备注 底稿韩磊挪动小组 APP接口标准文档 目录 一、概括1 1.1相关接口1 1.1.1接口是纯数据的交互1 1.2接口的分类1 1.2.1查问类接口1 1.2.2操作类接口1 1.2.3上传下载类接口1 1.2.4推送类接口1 二、查问类接口格式标准1 2.1获得单条对象信息1 2.1.1恳求格式1 2.1.2参数说明2 2.1.3正常返回结果2 2.2获得列表对象信息3 2.2.1恳求格式3 2.2.2参数说明3 2.2.3正常返回结果3 三、操作类接口4 3.1新增操作4 3.1.1接口说明4 3.1.2参数说明4 3.1.3正常返回结果4 3.1.4错误返回列表5 3.2改正操作5 3.2.1接口说明5 3.2.2参数说明5 3.2.3正常返回结果5 3.2.4错误返回列表5 3.3删除操作6 3.3.1接口说明6 3.3.2参数说明6 3.3.3正常返回结果6 3.3.4错误返回列表6 四、上传下载类7 4.1上传文件7 4.1.1接口说明7 4.1.2参数说明7 4.1.3正常返回结果7 4.1.4错误返回列表7 4.2下载文件7 4.2.1接口说明7 APP接口标准文档 4.2.2参数说明8 4.2.3正常返回结果8 4.2.4错误返回列表8 五、推送类接口8 5.1推送信息8 5.1.1接口说明8 5.1.2参数说明8 5.1.3正常返回结果9 5.1.4错误返回列表9 六、通用返回格式9 6.1正确返回9 6.1.1接口说明9 6.1.2参数说明9 6.1.3正常返回结果9 6.1.4错误返回列表10 6.2错误返回10 6.2.1接口说明10 6.2.2参数说明10 6.2.3正常返回结果10 6.2.4错误返回列表10 七、附录11 7.1通用错误返回列表11 7.2URL地点信息11 7.2.1主机地点11 7.2.2URL列表11 7.3安全系统11 7.3.1考证署名系统11 7.4其余12 7.2.1列表数据为空的返回12 APP接口标准文档 一、概括 1.1相关接口 接口是纯数据的交互 APP接口是挪动设施和业务之间进行通讯的门路。实质就是以特定的规那么经过接口直 接操作数据库的增改正查。 1.2接口的分类 查问类接口 查问类接口是指客户端传达一些参数，效力端依据参数依据需求，前去数据库查问需要 的结果返回数据的一类接口。 返回种类一般有两种。第一种是返回一个对象，第二种是返回一个数组对象。 第一种比方登岸，客户端把用户名密码上传到接口，效力器返回用户的个人信息。 第二种比方获得客户，客户端把用户的身份信息上传到接口，效力器返回此身份下的所 有客户数组会合。 1.2.2操作类接口 操作类接口是指，客户端经过接口进行一些增改正的操作。比方新增一个客户，改正客 户信息，或许删除一个客户。效力器一般返回履行的状态，有的需要返回履行结果的一些信 息，比方新增客户后，返回客户的ID。 上传下载类接口 上传下载类接口是波及到文件传输的接口。比方上传头像，需要上传图片到效力器，服 务端依据需求响应保留并返回结果。比方客户端需要显示用户头像，需要读取网络图片文件， 在进步行显示。 推送类接口 除了客户端主动去恳求效力端，获得需要信息以外。有时，也存在效力端有信息需要 通知客户端的状况，这时候就是效力端向客户端发送信息。这种需求能够经过客户端短时间 类循环恳求解决，也能够经过第三方专业推送解决。也能够经过自己使用socket或许xmpp 等协议进行开发。 二、查问类接口格式标准 2.1获得单条对象信息 2.1.1恳求格式 URL 支持格式JOSN 1 APP接口标准文档 恳求方式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错误返回列表 详见：通用错误返回列表