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