系统数据

Alex大约 12 分钟开发文档API接口文档

系统数据

v1.0.0

Base URLs:

Authentication

用户基本信息表

GET 发送邮件验证码

GET /front/sys/captcha/email

发送邮件验证码

请求参数

名称	位置	类型	必选	说明
email	query	string	是	email

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 生成图像验证码

GET /front/sys/captcha/index

返回的是图片二进制内容

请求参数

名称	位置	类型	必选	说明
verify_key	query	string	是	verify_key

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 发送手机验证码

GET /front/sys/captcha/mobile

发送手机验证码

请求参数

名称	位置	类型	必选	说明
mobile	query	string	是	mobile

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

系统参数设置表

GET 站点帮助

GET /front/sys/config/getPcHelp

站点帮助

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 根据提货码获取二维码

GET /front/sys/config/getQrcode

根据提货码获取二维码

请求参数

名称	位置	类型	必选	说明
code	query	string	是	code
w	query	integer	否	w
h	query	integer	否	h

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 加载广告导航

GET /front/sys/config/guide

加载广告导航

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 站点配置信息

GET /front/sys/config/info

站点配置信息

请求参数

名称	位置	类型	必选	说明
source_ucc_code	query	string	否	source_ucc_code

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 读取移动端语言包数据

GET /front/sys/config/listTranslateLang

读取移动端语言包数据

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 获取公钥

GET /front/sys/config/publicKey

站点配置信息

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

地区管理

GET 区域管理

GET /front/sys/district/tree

获得地址区域

请求参数

名称	位置	类型	必选	说明
createTimeEnd	query	string	否	创建时间结束值
createTimeStart	query	string	否	创建时间起始值
districtCitycode	query	string	否	区号
districtId	query	integer	否	地区编号
districtLat	query	number	否	维度
districtLevel	query	integer	否	地区等级
districtLng	query	number	否	经度
districtName	query	string	否	地区名称
districtParentId	query	integer	否	上级编号
districtSort	query	integer	否	地区排序
districtZipcode	query	string	否	邮编
like[0].column	query	string	否	搜索字段
like[0].like	query	string	否	搜索字符
order[0].sidx	query	string	否	排序字段
order[0].sort	query	string	否	排序方式
page	query	integer	否	分页查询页码
sidx	query	string	否	排序字段
size	query	integer	否	分页查询每页数量
sort	query	string	否	排序方式

返回示例

200 Response

{
  "code": 0,
  "data": [
    {
      "children": [
        null
      ],
      "district_citycode": "string",
      "district_id": 0,
      "district_lat": 0,
      "district_level": 0,
      "district_lng": 0,
      "district_name": "string",
      "district_parent_id": 0,
      "district_sort": 0,
      "district_zipcode": "string"
    }
  ],
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

快递表

GET 快递表-获取列表数据

GET /front/sys/express/list

快递表-获取列表数据

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

用户反馈反馈

POST 添加平台反馈-举报

POST /front/sys/feedback/add

添加平台反馈-举报

请求参数

名称	位置	类型	必选	说明
adminId	query	integer	否	回复人员
feedbackCategoryId	query	integer	否	分类编号
feedbackQuestion	query	string	否	反馈问题:在这里描述您遇到的问题
feedbackQuestionAnswer	query	string	否	反馈问题
feedbackQuestionAnswerTime	query	string	否	回复时间
feedbackQuestionResult	query	integer	否	举报处理结果(ENUM):1-无效举报;2-恶意举报;3-有效举报
feedbackQuestionStatus	query	string	否	举报状态(BOOL):0-未处理;1-已处理
feedbackQuestionTime	query	string	否	反馈时间
feedbackQuestionUrl	query	string	否	页面链接
itemId	query	integer	否	产品编号
userId	query	integer	否	用户编号
userNickname	query	string	否	用户昵称

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 平台反馈-举报

GET /front/sys/feedback/getCategory

平台反馈-举报

返回示例

200 Response

{
  "code": 0,
  "data": [
    {
      "feedback_type_enable": false,
      "feedback_type_genus": 0,
      "feedback_type_id": 0,
      "feedback_type_name": "string",
      "rows": [
        {
          "feedback_category_enable": false,
          "feedback_category_id": 0,
          "feedback_category_name": "string",
          "feedback_type_id": 0
        }
      ]
    }
  ],
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 平台反馈-反馈列表

GET /front/sys/feedback/list

平台反馈-反馈列表

请求参数

名称	位置	类型	必选	说明
page	query	integer	否	page
size	query	integer	否	size

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": [
      {
        "admin_id": 0,
        "feedback_category_id": 0,
        "feedback_id": 0,
        "feedback_question": "string",
        "feedback_question_answer": "string",
        "feedback_question_answer_time": "2019-08-24T14:15:22Z",
        "feedback_question_result": 0,
        "feedback_question_status": false,
        "feedback_question_time": "2019-08-24T14:15:22Z",
        "feedback_question_url": "string",
        "item_id": 0,
        "user_id": 0,
        "user_nickname": "string"
      }
    ],
    "page": 0,
    "records": 0,
    "size": 0,
    "total": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

页面表

GET 页面表-分页列表查询

GET /front/sys/page/getMobileIndexNav

页面表-分页列表查询

请求参数

名称	位置	类型	必选	说明
createTimeEnd	query	string	否	创建时间结束值
createTimeStart	query	string	否	创建时间起始值
like[0].column	query	string	否	搜索字段
like[0].like	query	string	否	搜索字符
order[0].sidx	query	string	否	排序字段
order[0].sort	query	string	否	排序方式
page	query	integer	否	分页查询页码
pageBuildin	query	string	否	是否内置(BOOL):0-否;1-是
pageName	query	string	否	页面名称
pageType	query	integer	否	类型(ENUM):1-WAP;2-PC;3-APP
sidx	query	string	否	排序字段
size	query	integer	否	分页查询每页数量
sort	query	string	否	排序方式
storeId	query	integer	否	所属店铺
subsiteId	query	integer	否	所属分站:0-总站

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": [
      {
        "app_id": 0,
        "page_activity": false,
        "page_article": false,
        "page_buildin": false,
        "page_code": "string",
        "page_config": "string",
        "page_everyday": false,
        "page_exchange": false,
        "page_gb": false,
        "page_gbs": false,
        "page_higharea": false,
        "page_id": 0,
        "page_index": false,
        "page_likeyou": false,
        "page_message": false,
        "page_name": "string",
        "page_nav": "string",
        "page_new": false,
        "page_newperson": false,
        "page_package": false,
        "page_pfgb": false,
        "page_point": false,
        "page_qrcode": "string",
        "page_release": false,
        "page_rura": false,
        "page_secondday": false,
        "page_secondkill": false,
        "page_share_image": "string",
        "page_share_title": "string",
        "page_sns": false,
        "page_taday": false,
        "page_tpl": 0,
        "page_type": 0,
        "page_upgrade": false,
        "page_zerobuy": false,
        "store_id": 0,
        "subsite_id": 0,
        "user_id": 0
      }
    ],
    "page": 0,
    "records": 0,
    "size": 0,
    "total": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 读取移动页面

GET /front/sys/page/getMobilePage

读取移动页面

请求参数

名称	位置	类型	必选	说明
categoryId	query	integer	否	分类编号
pageId	query	integer	否	页面编号
pageIndex	query	string	否	主页类型

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 读取PC页面

GET /front/sys/page/getPcPage

读取PC页面

请求参数

名称	位置	类型	必选	说明
categoryId	query	integer	否	分类编号
pageId	query	integer	否	页面编号
pageIndex	query	string	否	主页类型

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET PC头尾数据

GET /front/sys/page/pcLayout

PC头尾数据

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

图片上传

POST 上传base64文件

POST /front/sys/upload/base64

请求参数

名称	位置	类型	必选	说明
base64	query	string	是	base64
fileName	query	string	否	文件名称

返回示例

200 Response

{
  "code": 0,
  "data": {
    "file_name": "string",
    "file_path": "string",
    "file_size": 0,
    "file_type": "string",
    "file_url": "string",
    "mime_type": "string",
    "url": "string",
    "user_id": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 下载原文件

GET /front/sys/upload/download/{type}/{dir}/

请求参数

名称	位置	类型	必选	说明
type	path	string	是	type
dir	path	string	是	dir
name	path	string	是	name

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 上传文件

POST /front/sys/upload/index

Body 请求参数

"string"

请求参数

名称	位置	类型	必选	说明
galleryId	query	integer	否	素材分类
materialKey	query	string	否	素材关键字
materialType	query	string	否	素材类型
body	body	string(binary)	否	none

返回示例

200 Response

{
  "code": 0,
  "data": {
    "file_name": "string",
    "file_path": "string",
    "file_size": 0,
    "file_type": "string",
    "file_url": "string",
    "mime_type": "string",
    "url": "string",
    "user_id": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 查看缩略图

GET /front/sys/upload/thumbnail/{type}/{dir}/

请求参数

名称	位置	类型	必选	说明
type	path	string	是	type
dir	path	string	是	dir
name	path	string	是	name

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 查看原文件

GET /front/sys/upload/{type}/{dir}/

请求参数

名称	位置	类型	必选	说明
type	path	string	是	type
dir	path	string	是	dir
name	path	string	是	name

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline