readme.txt 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <h3>一、测试环境</h3>
  2. 1、接口文档: http://120.79.211.173:7100/apidoc/index.html
  3. 2、接口地址: http://120.79.211.173:7100/bore/app/open/v1
  4. 3、图片服务: http://120.79.211.173:7100/file/upload/head/2/10000002.jpg
  5. 4、后台地址:
  6. <h3>二、通用服务环境</h3>
  7. 1、接口文档: http://120.79.211.173:7000/apidoc/index.html
  8. 已使用服务: 短信,订单系统
  9. <h3>三、交互规范</h3>
  10. 1、自定义http头部
  11. 1.1、My-User-Agent, 格式:渠道名(Android/iOS)#客户端型号#接口版本号#客户端UI版本号 eg: Android#HUAWEI-P30#101#100。
  12. 1.2、My-Token, 帐号密码登陆/短信登陆/微信授权登陆,登陆成功返回token,客户端下次请求通过http头部带上token。
  13. 2、http请求方法约束
  14. 1.1、GET 表示从服务端取数据
  15. 1.2、PUT 表示新增东西到服务端,方法不幂等
  16. 1.3、POST 表示更新东西到服务端,方法幂等
  17. 1.4、DELETE 标示从服务端删除数据
  18. 3、接口签名验证
  19. 2.1、接口签名(swagger接口调用不验证签名),签名算法如下:
  20. 签名参数:业务请求参数 spTimestamp(毫秒数,当前时间) spSignKey(签名key) spSign(签名结果)。
  21. 签名逻辑:业务请求参数和spTimestamp一起按字母升序排列(注意:spSignKey、spSign、值为null不参与签名)。再拼上spSignKey。 MD5 32位十六进制大写。
  22. 签名样例:
  23. 步骤1、请求参数=> spTimestamp=1560136106147 spSign=EF2D9E01E0802143BAFDBA826697AB35 spSignKey=hellojava userId=10000001 nickname=null token=123456
  24. 步骤2、spTimestamp+业务请求参数 按字母升序排列(spSign、spSignKey、值为null不参与签名) => spTimestamp=1560136106147&token=123456&userId=10000001
  25. 步骤3、再拼上spSignKey。=> spTimestamp=1560136106147&token=123456&userId=10000001&spSignKey=hellojava
  26. 步骤4、MD5 32位十六进制大写。spSign => EF2D9E01E0802143BAFDBA826697AB35
  27. 4、请求响应
  28. 3.1、返回格式: { \"code\" : 200, \"msg\": \"\", \"data\": null}, data为具体业务返回数据
  29. 3.2、对象为空返回null, 数组为空返回[]
  30. 3.3、常见响应码 200-成功 400-参数异常 403-需要登陆 500-系统错误