接口描述:

  • 获取某个模块的设置。

请求 URL:

  • http|https://host/api/v1/setting/method/get.setting.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
module string 见附属 A delivery_dist 模块

附属 A:

module 名称
delivery_dist 配送轨迹
payment 支付完成提示页
delivery 配送优惠
system_shopping 购物系统
service 售后服务
system_info 系统配置
upload 上传配置

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
键名 类型 是否返回 示例值 描述
code string 变量名
value mixed 变量值
module string 所属模块
description string 描述

响应示例:

delivery_dist

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "api_id": {
  6. "code": "api_id",
  7. "value": 1212210,
  8. "module": "delivery_dist",
  9. "description": "快递鸟商户ID"
  10. },
  11. "api_key": {
  12. "code": "api_key",
  13. "value": "e5257ae3-7ac9-477d-a5d1-54cd7fc93974",
  14. "module": "delivery_dist",
  15. "description": "快递鸟ApiKey"
  16. },
  17. "is_sub": {
  18. "code": "is_sub",
  19. "value": 1,
  20. "module": "delivery_dist",
  21. "description": "是否启用订阅"
  22. }
  23. }
  24. }

payment

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "success": {
  6. "code": "success",
  7. "value": "http://www.careyshop.cn/",
  8. "module": "payment",
  9. "description": "支付成功提示页"
  10. },
  11. "error": {
  12. "code": "error",
  13. "value": "http://www.careyshop.cn/",
  14. "module": "payment",
  15. "description": "支付失败提示页"
  16. }
  17. }
  18. }

delivery

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "money": {
  6. "code": "money",
  7. "value": 88.88,
  8. "module": "delivery",
  9. "description": "满额包邮"
  10. },
  11. "money_status": {
  12. "code": "money_status",
  13. "value": 1,
  14. "module": "delivery",
  15. "description": "满额是否启用"
  16. },
  17. "money_exclude": {
  18. "code": "money_exclude",
  19. "value": [
  20. "32",
  21. "27",
  22. "6",
  23. "30",
  24. "33",
  25. "34",
  26. "35",
  27. "36"
  28. ],
  29. "module": "delivery",
  30. "description": "满额不包邮区域"
  31. },
  32. "number": {
  33. "code": "number",
  34. "value": 21,
  35. "module": "delivery",
  36. "description": "满件包邮"
  37. },
  38. "number_status": {
  39. "code": "number_status",
  40. "value": 1,
  41. "module": "delivery",
  42. "description": "满件是否启用"
  43. },
  44. "number_exclude": {
  45. "code": "number_exclude",
  46. "value": [
  47. "32",
  48. "27",
  49. "6",
  50. "30",
  51. "33",
  52. "34",
  53. "35",
  54. "36"
  55. ],
  56. "module": "delivery",
  57. "description": "满件不包邮区域"
  58. },
  59. "quota": {
  60. "code": "quota",
  61. "value": 200,
  62. "module": "delivery",
  63. "description": "满额减运费"
  64. },
  65. "dec_money": {
  66. "code": "dec_money",
  67. "value": 10,
  68. "module": "delivery",
  69. "description": "满额减多少运费"
  70. },
  71. "dec_status": {
  72. "code": "dec_status",
  73. "value": 1,
  74. "module": "delivery",
  75. "description": "满额减是否启用"
  76. },
  77. "dec_exclude": {
  78. "code": "dec_exclude",
  79. "value": [
  80. "32",
  81. "27",
  82. "11",
  83. "30",
  84. "33",
  85. "34",
  86. "35",
  87. "36"
  88. ],
  89. "module": "delivery",
  90. "description": "满额减不减区域"
  91. }
  92. }
  93. }

system_shopping

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "integral": {
  6. "code": "integral",
  7. "value": 100,
  8. "module": "system_shopping",
  9. "description": "积分换算比例"
  10. },
  11. "timeout": {
  12. "code": "timeout",
  13. "value": 30,
  14. "module": "system_shopping",
  15. "description": "下单后未付款自动取消(分)"
  16. },
  17. "complete": {
  18. "code": "complete",
  19. "value": 10,
  20. "module": "system_shopping",
  21. "description": "发货几天后自动确认收货(天)"
  22. },
  23. "is_country": {
  24. "code": "is_country",
  25. "value": 0,
  26. "module": "system_shopping",
  27. "description": "完整地址是否包含国籍"
  28. },
  29. "spacer": {
  30. "code": "spacer",
  31. "value": " ",
  32. "module": "system_shopping",
  33. "description": "完整地址间隔符"
  34. },
  35. "invoice": {
  36. "code": "invoice",
  37. "value": 3,
  38. "module": "system_shopping",
  39. "description": "开票收取多少税率"
  40. }
  41. }
  42. }

service

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "days": {
  6. "code": "days",
  7. "value": 15,
  8. "module": "service",
  9. "description": "有效维权期天数"
  10. },
  11. "address": {
  12. "code": "address",
  13. "value": "浙江省 宁波市 江北区",
  14. "module": "service",
  15. "description": "退换货地址"
  16. },
  17. "consignee": {
  18. "code": "consignee",
  19. "value": "王五",
  20. "module": "service",
  21. "description": "退换货收件人"
  22. },
  23. "zipcode": {
  24. "code": "zipcode",
  25. "value": 315000,
  26. "module": "service",
  27. "description": "退换货邮编"
  28. },
  29. "mobile": {
  30. "code": "mobile",
  31. "value": 15867431111,
  32. "module": "service",
  33. "description": "退换货联系电话"
  34. }
  35. }
  36. }

system_info

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "open_index": {
  6. "code": "open_index",
  7. "value": 1,
  8. "module": "system_info",
  9. "description": "是否开启首页"
  10. },
  11. "open_api": {
  12. "code": "open_api",
  13. "value": 1,
  14. "module": "system_info",
  15. "description": "是否开启API接口"
  16. },
  17. "open_mobile": {
  18. "code": "open_mobile",
  19. "value": 1,
  20. "module": "system_info",
  21. "description": "是否开启移动页"
  22. },
  23. "close_reason": {
  24. "code": "close_reason",
  25. "value": "系统维护中,请稍后访问!",
  26. "module": "system_info",
  27. "description": "关闭原因"
  28. },
  29. "name": {
  30. "code": "name",
  31. "value": "CarayShop",
  32. "module": "system_info",
  33. "description": "商城名称"
  34. },
  35. "title": {
  36. "code": "title",
  37. "value": null,
  38. "module": "system_info",
  39. "description": "商城标题"
  40. },
  41. "keywords": {
  42. "code": "keywords",
  43. "value": null,
  44. "module": "system_info",
  45. "description": "商城关键词"
  46. },
  47. "description": {
  48. "code": "description",
  49. "value": null,
  50. "module": "system_info",
  51. "description": "商城描述"
  52. },
  53. "logo": {
  54. "code": "logo",
  55. "value": null,
  56. "module": "system_info",
  57. "description": "商城LOGO"
  58. },
  59. "third_count": {
  60. "code": "third_count",
  61. "value": "",
  62. "module": "system_info",
  63. "description": "第三方统计代码"
  64. },
  65. "withdraw_fee": {
  66. "code": "withdraw_fee",
  67. "value": 6.5,
  68. "module": "system_info",
  69. "description": "提现手续费"
  70. },
  71. "miitbeian": {
  72. "code": "miitbeian",
  73. "value": "浙ICP备16046721号-1",
  74. "module": "system_info",
  75. "description": "ICP备案许可证号"
  76. },
  77. "miitbeian_url": {
  78. "code": "miitbeian_url",
  79. "value": "http://www.miitbeian.gov.cn",
  80. "module": "system_info",
  81. "description": "ICP备案链接地址"
  82. },
  83. "miitbeian_ico": {
  84. "code": "miitbeian_ico",
  85. "value": null,
  86. "module": "system_info",
  87. "description": "ICP备案图标"
  88. },
  89. "beian": {
  90. "code": "beian",
  91. "value": null,
  92. "module": "system_info",
  93. "description": "公安机关备案号"
  94. },
  95. "beian_url": {
  96. "code": "beian_url",
  97. "value": "http://www.beian.gov.cn",
  98. "module": "system_info",
  99. "description": "公安机关备案链接"
  100. },
  101. "beian_ico": {
  102. "code": "beian_ico",
  103. "value": null,
  104. "module": "system_info",
  105. "description": "公安机关备案图标"
  106. },
  107. "weixin_url": {
  108. "code": "weixin_url",
  109. "value": "http://www.careyshop.cn/",
  110. "module": "system_info",
  111. "description": "安卓安装包微信中间页地址"
  112. },
  113. "qrcode_logo": {
  114. "code": "qrcode_logo",
  115. "value": "static/api/images/qrcode_logo.png",
  116. "module": "system_info",
  117. "description": "二维码LOGO"
  118. }
  119. }
  120. }

upload

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "default": {
  6. "code": "default",
  7. "value": "qiniu",
  8. "module": "upload",
  9. "description": "默认资源上传模块"
  10. },
  11. "oss": {
  12. "code": "oss",
  13. "value": "careyshop.cn/oss?url=",
  14. "module": "upload",
  15. "description": "OSS获取入口"
  16. },
  17. "image_ext": {
  18. "code": "image_ext",
  19. "value": "jpg,png,gif,jpeg,jpeg,bmp,webp",
  20. "module": "upload",
  21. "description": "图片允许上传的后缀"
  22. },
  23. "file_ext": {
  24. "code": "file_ext",
  25. "value": "doc,docx,xls,xlsx,ppt,pptx,pdf,wps,txt,rar,zip,gz,bz2,7z,pem,mp4",
  26. "module": "upload",
  27. "description": "文件允许上传的后缀"
  28. },
  29. "file_size": {
  30. "code": "file_size",
  31. "value": "2M",
  32. "module": "upload",
  33. "description": "本地上传附件大小限制"
  34. },
  35. "qiniu_access_key": {
  36. "code": "qiniu_access_key",
  37. "value": "-eibVM1dkuOQU9vbuhoMRbiMtw4t_-QUMQJgPPDJ",
  38. "module": "upload",
  39. "description": "用于签名的公钥"
  40. },
  41. "qiniu_secret_key": {
  42. "code": "qiniu_secret_key",
  43. "value": "pcDGWPh8eOvnvcWBklyhAod0R6MiC3_OU-V4hayZ",
  44. "module": "upload",
  45. "description": "用于签名的私钥"
  46. },
  47. "qiniu_bucket": {
  48. "code": "qiniu_bucket",
  49. "value": "careyshop",
  50. "module": "upload",
  51. "description": "请保证Bucket为可公共读取的"
  52. },
  53. "qiniu_url": {
  54. "code": "qiniu_url",
  55. "value": "p2oo9yitf.bkt.clouddn.com",
  56. "module": "upload",
  57. "description": "对外访问域名"
  58. },
  59. "aliyun_access_key": {
  60. "code": "aliyun_access_key",
  61. "value": "LTAIujASEnhdoDWO",
  62. "module": "upload",
  63. "description": "AccessKeyID"
  64. },
  65. "aliyun_secret_key": {
  66. "code": "aliyun_secret_key",
  67. "value": "wpEQEFZRHVW9Ty87MjYy7bFTKBWgXA",
  68. "module": "upload",
  69. "description": "AccessKeySecret"
  70. },
  71. "aliyun_bucket": {
  72. "code": "aliyun_bucket",
  73. "value": "careyshop",
  74. "module": "upload",
  75. "description": "请保证Bucket为可公共读取的"
  76. },
  77. "aliyun_url": {
  78. "code": "aliyun_url",
  79. "value": "careyshop.oss-cn-hangzhou.aliyuncs.com",
  80. "module": "upload",
  81. "description": "对外访问域名"
  82. },
  83. "aliyun_endpoint": {
  84. "code": "aliyun_endpoint",
  85. "value": "oss-cn-hangzhou.aliyuncs.com",
  86. "module": "upload",
  87. "description": "EndPoint"
  88. },
  89. "aliyun_rolearn": {
  90. "code": "aliyun_rolearn",
  91. "value": "acs:ram::1763866218345155:role/aliyunosstokengeneratorrole",
  92. "module": "upload",
  93. "description": "RoleArn"
  94. }
  95. }
  96. }

备注:

  1. 不同的模块返回的数据内容会不同,但数据结构都是一样的。
文档更新时间: 2018-06-10 01:56