《2022年接口设计规范V.---参考.docx》由会员分享，可在线阅读，更多相关《2022年接口设计规范V.---参考.docx（13页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、精选学习资料 - - - - - - - - - 服务端与手机平台接口协议BespRout 2022 年 11 月文档修改 /审批记录名师归纳总结 版本号修改人 / 审批人修改 / 审批日期修改内容备注第 1 页,共 8 页V1.0 林成民2022-11-12 创建V1.0 林成民2022-11-19 添加商家和品牌相关等的- - - - - - -精选学习资料 - - - - - - - - - 接口V1.0 林成民2022-11-21 添加 Ordering相关等接口V1.0 吴秋锦2022-11-24 更换前缀 +coupon 接口V1.0 林成民2022-4-28 修改4.61 、4.
2、64 、 4.47 、4.49 、4.50接口,并且添加 4.86 接口V1.0 林成民2022-5-18 修改4.66接口的参数说明 , 新 增4.87 、 4.88 、4.89 、4.90 接口V1.0 林成民2022-5-27 修改 4.90 接口（添加相关的响应参数）,添加新接口 4.91 V1.0 林成民2022-8-06 修改4.64 ,添加是否显示同步用户信息按钮V1.0 林成民2022-8-12 修改 4.49 、4.50 接口V1.0 林成民2022-12-14 修改 4.3 、4.68 接口目录1.概述 32.涉及接口 33.接口总体要求 33.1.系统间接口的原就 33.
3、2.处理流程 33.3.接口实现方式 44.XXX 服务端接口 44.1.XX 模块 -依据 XX 下载相关的配置文件 44.2.XX 模块 -生成指定 XX 的文件配置 54.3.APP 启动 -初使化参数 65.附件 7名师归纳总结 - - - - - - -第 2 页,共 8 页精选学习资料 - - - - - - - - - 5.1.备注说明 71. 概述本文档供应接口给手机端使用,为手机端供应业务平台数据2. 涉及接口本文档涉及的外围系统接口包括：无3. 接口总体要求3.1. 系统间接口的原就接口设计遵循如下原就：安全牢靠性原就：系统应供应良好的安全性和牢靠性策略,支持多种安全 而牢
4、靠的技术手段,制定严格的安全牢靠的治理措施；开放性原就：供应开放式标准接口,供应与其它系统的互联互通；敏捷性原就：供应敏捷的接口设计,便于接口的变动；可扩展性原就：支持新业务的扩展以及接口容量与接口性能的提高；可治理性原就：供应良好的治理机制,保证在运行过程中供应应治理员方 便的治理方式以处理各种情形；统一性原就：应当保证系统的接口方式、接口形式、使用的协议等标准、统一；3.2. 处理流程接口处理流程名师归纳总结 - - - - - - -第 3 页,共 8 页精选学习资料 - - - - - - - - - android 手机；ht t p恳求；ht t p请 求iphone 手机3.3.
5、 接口实现方式手机 APP应用与服务端采纳基于 HTTP的 REST协议完成,数据传输默认为 JSON 恳求消息 JSON（具体见下面各列表 应答消息 json JSON格式 接口协议 http（rest协议）接 口 实 现 Mascar_qis 服务端者主 要 使 用 手机 APP（android&iphone）者4. XXX 服务端接口测试地址前缀 :http:/192.168.3.208:8088/xxx/xxx 4.1. XX模块- 依据 XX下载相关的配置文件接口名称 下载相关的配置文件接口描述 依据厂商 ID 下载相关的配置文件测试地址 前缀+/file/download/stor
6、eId.token = token 参数详见配置名师归纳总结 - - - - - - -第 4 页,共 8 页精选学习资料 - - - - - - - - - 恳求方式 GET 正式地址 待定参数恳求体参数参数含义类型长度必填说明或patform 平台String 20 必填值为 iphone者 android 响应体 无4.2. XX模块- 生成指定 XX的文件配置接口名称 生成指定商家的文件配置 接口描述 依据厂商 ID,生成指定商家的文件配置 测试地址 前缀+/file/generate/storeId.token= token 参数详见配置 恳求方式 GET 正式地址 待定参数恳求体
7、无 响应体名师归纳总结 参数参数含义数据类型说明第 5 页,共 8 页respCode 标识是否操作胜利String 0胜利 1 失败respDesc 当标识 respCode为 1String 时候显示错误信息- - - - - - -精选学习资料 - - - - - - - - - 4.3. APP启动- 初使化参数接口名称 初使化参数接口接口描述 初使化参数接口测试地址 前缀+/brands/param/list.token= token 参数详见配置恳求方式 GET 正式地址 待定恳求参数无响应体参数参数含义数据类说明型名师归纳总结 respCode 标识是否操作胜利String 0
8、胜利1 失第 6 页,共 8 页败respDesc 当标识 respCode为 1 时候显String 示错误信息shareFacebookUrl fb 共享的地址String shareFacebookKey fb 共享的内容String shareFacebookSecret String shareFacebookInfo String shareTwitterUrl String tw 共享的地址shareTwitterKey String shareTwitterSecret tw 共享的内容String shareTwitterInfo String shareEmail Stri
9、ng email 共享的标题shareEmailTitle String - - - - - - -精选学习资料 - - - - - - - - - maxNumOfFamilyMe最多答应加入的家庭成员的个String mber 数String 1-guidingTextOfHBC HBC 引导文字helpTextOfHBC String HBC 帮忙文字payType String 支付类型A ,2-TrustCommer ce,3-ProPay 注：以上全部内容需先5. 附件5.1. 备注说明token 算法生成说明：加密方式：手机与服务端各持有密钥Base64解,再 DES解才可得到定
10、义的内容Key,密钥暂定为 XXXX ；token=Base64（ “time= &num=&accessToken=&version=&appId=&brandId=& platform=& phoneUUID= ” ）Key 值 说明time 当前时间的 long 值num 5 位数字和字母的随机字符串accessToken DesKey, time _ num ” appId 后台安排的用户 Id调用注册或者没有 id 直接使用 initversion App 当前版本号brandId 后台安排的品牌 Idplatform 平台类型：iphone/iphoneLite名师归纳总结 - - - - - - -第 7 页,共 8 页精选学习资料 - - - - - - - - - android/androidLitephoneUUID token：安装软件后唯独标识64UUID开发过程中,可以先传一个固定xxx备注：0胜利 1失败respCode 标识是否操作胜利String 2 用 户 其 他手机登录3 用 户 登 录 后,被锁；respDesc 当标识 respCode为 1 时候显示错误String 信息假如 2 或者 3 需要强行弹框,点击后直接退出到登录界面；1 视业务规律,挑选是否强框名师归纳总结 - - - - - - -第 8 页,共 8 页