[关闭]
@xuduochoua 2017-10-13T02:31:08.000000Z 字数 4128 阅读 1474

ICP接口

接口 winsky


一、接口文档

接口通用说明

  1. {
  2. code:0,//返回码 0-默认 成功
  3. msg:"",//错误码说明信息
  4. data:null//接口需求的具体数据 或List 或String 等
  5. }
  1. http://192.168.0.36:10082/
  1. 401 : 未登录
  2. 400 请求参数错误

一、后台

1.1.登陆

接口地址:
POST /console/login

这个登陆暂时就一个账号写在配置数据库 admin:123456

请求参数:

参数 数据类型 必填 参数说明
username string Y 账户
username string Y 密码

错误码说明

code 错误原因 返回消息
609 密码错误 密码错误
608 不存的用户 不存在的用户

响应结果:

  1. {
  2. "code": 0, //0 - 接口调用成功,其他值表示失败
  3. "message": "",
  4. "data": {
  5. "username;":"xxx"
  6. }
  7. }

1.2 退出登陆

接口地址:
POST /console/logout
请求参数:

参数 数据类型 必填 参数说明
username String Y 用户id

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:null
  5. }

1.3 发布信息列表

接口地址:
POST /console/publishes

时间倒序
请求参数:

参数 数据类型 必填 参数说明
page int N 分页参数-当前页码
size int N 分页参数-当前页数据量
examined Integer N 是否通过审核 2-不通过 1-已审核 0-未审核
contacts String N 联系人
phone String N 电话
companyName String N 公司名称

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code: 0,
  3. msg: "",
  4. data: {
  5. list: [//数据列表
  6. {
  7. id: 3,
  8. title: "222222222222",
  9. bannerUrl: "",//bannerUrl
  10. content: "asdasdad ",//内容
  11. contacts: "asd",//联系方式
  12. phone: "18011112222",
  13. email: "xxxsx@163.com",
  14. qq: "84597585",
  15. wechat: "84597585",
  16. companyName: "asda",
  17. companyAddress: "asd",
  18. createTime: "2017-09-22",
  19. ip: "564654",
  20. examined: 1,//是否通过审核 2-不通过 1-已审核 0-未审核
  21. examiner: "admin",//审核人
  22. examineTime: "2017-09-08"//审核时间
  23. }
  24. ],
  25. total: 2,//总时刻量
  26. pageNum: 1,//当前第几页
  27. pageSize: 1,//每页数据量
  28. pages: 2,//总页数
  29. size: 1//当前页数据量
  30. }
  31. }

1.4 发布信息详情

接口地址:
POST /console/publish

请求参数:

参数 数据类型 必填 参数说明
id int Y 信息id

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:{//同1.3
  5. }
  6. }

1.5 审核发布

接口地址:
POST /console/examine
请求参数:

参数 数据类型 必填 参数说明
examined int Y 2-不通过 1-通过
id int Y 信息id

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:{}
  5. }

1.6 敏感词列表

接口地址:
POST /console/words
请求参数:

参数 数据类型 必填 参数说明

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:[
  5. "xx","yy"
  6. ]
  7. }

1.7 新增敏感词

接口地址:
POST /console/addWord
请求参数:

参数 数据类型 必填 参数说明
name String Y 词汇

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:{}
  5. }

1.8 删除敏感词

接口地址:
POST /console/delWord
请求参数:

参数 数据类型 必填 参数说明
name String Y 词汇

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:{}
  5. }

1.9 历史访问记录

接口地址:
POST /console/accesses
请求参数:

参数 数据类型 必填 参数说明
page int N 当前页码
size int N 数据量
contacts String N 联系人
ip int N ip

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code: 0,
  3. msg: "",
  4. data: {//参考1.3 分页说明
  5. list: [
  6. {
  7. contacts: "asd",
  8. createTime: 1506043081000,
  9. ip: "564654"
  10. }
  11. ],
  12. total: 2,
  13. pageNum: 1,
  14. pageSize: 1,
  15. pages: 2,
  16. size: 1
  17. }
  18. }

二、前端接口

2.1.banner列表

接口地址:
POST /api/banners

请求参数:

参数 数据类型 必填 参数说明
brand int N 品牌分类 默认1

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:[{
  5. "id":1,
  6. "bannerUrl":"http://xxx/xx.jpg",
  7. "title":"xxxxx",
  8. "companyName":"winsky"
  9. },...
  10. ]
  11. }

2.2 发布信息(提交)

接口地址:
POST /api/publish

请求参数:

参数 数据类型 必填 参数说明
title String Y title
banner int Y banner的id
brand int Y 品牌分类
content String Y content
contacts String Y contacts
phone String Y phone
email String Y email
qq String Y qq
wechat String Y wechat
companyName String Y companyName
companyAddress String Y companyAddress
code String Y 验证码

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data: {}
  5. }

2.3 发布信息详情

接口地址:
GET /api/publish

请求参数:

参数 数据类型 必填 参数说明
id int Y 信息id

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:{
  5. id: 3,
  6. title: "222222222222",
  7. banner: "",//bannerUrl
  8. content: "asdasdad ",//内容
  9. contacts: "asd",//联系方式
  10. phone: "18011112222",
  11. email: "xxxsx@163.com",
  12. qq: "84597585",
  13. wechat: "84597585",
  14. companyName: "asda",
  15. companyAddress: "asd",
  16. createTime: "2017-09-22",
  17. ip: "564654",
  18. examined: 1,//是否通过审核 1-是 0否
  19. examiner: "admin",//审核人
  20. examineTime: "2017-09-08"//审核时间
  21. }
  22. }

2.4 上传附件

接口地址:
POST /api/upfile

请求参数:

参数 数据类型 必填 参数说明
upfile File Y 文件

运行时异常

code 错误原因 返回消息

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:{
  5. "id":1,//本次上传的附件id
  6. "url":"",//本附件相对地址
  7. }
  8. }

2.5 访问附件

此处一般指图片

接口地址:
GET /api/upfile/{id}

路径参数
id: 访问附件的id

请求参数

响应结果

  1. http://......//一个url

2.6 发送短信验证码

接口地址:
POST /api/smscode

请求参数:

参数 数据类型 必填 参数说明
mobile string Y 接收短信的手机号码

运行时异常

code 错误原因 返回消息
502 发送短信失败 发送短信失败

响应结果:

  1. {
  2. code:0,
  3. msg:"",
  4. data:{
  5. }
  6. }
  1. ### 2.7 关于我们
  2. **接口地址:**
  3. `POST` `/api/about`
  4. **请求参数:**
  5. |参数|数据类型|必填|参数说明
  6. |-|-|-|
  7. |无
  8. **运行时异常**
  9. code| 错误原因 |返回消息
  10. -----|---------|----
  11. 502|发送短信失败|发送短信失败|
  12. **响应结果:**

{
code:0,
msg:"",
data:{
{
companyName: "云杉智慧新能源技术有限公司",
companyAddress: "深圳市南山区迈科龙大厦15楼",
mobile: "400-111-8220",
contacts: "龚生",
logo: "winsky-logo.png",
desc: "

云杉智慧新能源技术有限公司(以下简称“云杉智慧”)成立于深圳前海,公司已获得深圳等城市新能源充电设施运营商资质。

云杉智慧经过城市快速充换电站技术研发和经验积累、综合运营平台研发和运营实践的技术验证与商业模式示范阶段、提供“车网协同 、智能互联、专业运维”绿色出行综合服务的发展阶段,规划在未来的2~3年时间里进入“线上线下一体化”阶段。

云杉智慧作为中国新能源汽车与充电运营行业的领军企业,放眼全球交通能源发展格局,率先建设中国最具规模的城市级快速充换电网络, 开发最智能的下一代电动汽车出行运营系统,探索最符合时代需要的电动汽车线下&线上服务,为电动汽车低碳智能出行提供有力支撑。 并站在产业链的高度,依托“车网协同、智能互联、专业运维”的商业模式推出电动汽车充电线下与线上服务、电动汽车智能出行服务、 电动汽车相关数据服务,提供充电设施及运营解决方案、绿色出行解决方案,致力于做中国最具影响力的城市级新能源出行服务平台!






二、sql

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注