[关闭]
@cfygaoyang 2018-05-03T02:08:00.000000Z 字数 8333 阅读 745

(平台)SDS Common

sds

获取token

GET /api/get_token?account=18888888888&verify_code=123456&app_id=xxxx-xxx-xxx-xxx

GET /api/get_token?account=18888888888&password=123456&app_id=xxxx-xxx-xxx-xxx

参数 类型 必须 说明
account 字符串 是 手机或邮箱
verify_code 字符串 是 验证码
app_id 字符串 是 厂商的APP_ID
参数 类型 必须 说明
account 字符串 是 手机或邮箱
password 字符串 是 密码
app_id 字符串 是 厂商的APP_ID

* 请求回调

  1. {
  2.     "message":{
  3.         "token_expire_in":604800,
  4.         "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoidG9rZW4iLCJ1c2VyX2lkIjoxLCJ0b2tlbl90aW1lIjoxNTA4NDY3NDAyfQ.ps7dPdN6-16ip5f4-fgfBZ5ye9Qu6oH9ADjz0iH1nvs",
  5.         "refresh_token_expire_in":1209600,
  6.         "refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaF90b2tlbiIsInVzZXJfaWQiOjEsInRva2VuX3RpbWUiOjE1MDkwNzIyMDJ9.1r6PRGStReI1YFUrgggCovF5DAiS9gWMBY8DXOi2zPs"
  7.     },
  8.     "code":0
  9. }
参数 类型 说明
token_expire_in 整形 token有效时间（秒）
token 字符串 token
refresh_token_expire_in 整形 refresh_token有效时间（秒）
refresh_token 字符串 refresh_token

绑定第三方账号

POST /api/oepn

  1. {
  2.     "open_id": "sdfghjklertyuio",
  3.     "open_type": 1,
  4.     "app_id": "dyuiosdfghjklsdfghjkl"
  5. }
参数 类型 必须 说明
open_id 字符串 是 第三方账号id
open_type 字符串 是 第三方账号类型: 1.QQ 2.微信 3.微博 4.淘宝
app_id 字符串 是 厂商的APP_ID 
  1. {
  2.     "code": 0,
  3.     "message": {
  4.         "data": {
  5.             "open_id": "sdfghjklertyuio",
  6.             "open_type": 1,
  7.             "app_id": "dyuiosdfghjklsdfghjkl",
  8.             "user_id": 1
  9.         }
  10.     }
  11. }

根据第三方账号获取token

GET /api/get_token_by_open?open_id=18888888888&open_type=1&app_id=xxxx-xxx-xxx-xxx

参数 类型 必须 说明
open_id 字符串 是 第三方账号id
open_type 字符串 是 第三方账号类型: 1.QQ 2.微信 3.微博 4.淘宝
app_id 字符串 是 厂商的APP_ID

* 请求回调

  1. {
  2.     "message":{
  3.         "token_expire_in":604800,
  4.         "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoidG9rZW4iLCJ1c2VyX2lkIjoxLCJ0b2tlbl90aW1lIjoxNTA4NDY3NDAyfQ.ps7dPdN6-16ip5f4-fgfBZ5ye9Qu6oH9ADjz0iH1nvs",
  5.         "refresh_token_expire_in":1209600,
  6.         "refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaF90b2tlbiIsInVzZXJfaWQiOjEsInRva2VuX3RpbWUiOjE1MDkwNzIyMDJ9.1r6PRGStReI1YFUrgggCovF5DAiS9gWMBY8DXOi2zPs"
  7.     },
  8.     "code":0
  9. }
参数 类型 说明
token_expire_in 整形 token有效时间（秒）
token 字符串 token
refresh_token_expire_in 整形 refresh_token有效时间（秒）
refresh_token 字符串 refresh_token

刷新token

PUT /api/reset_token

  1. {
  2.     "refresh_token": "1234567890"
  3. }
  1. {
  2.     "message":{
  3.         "token_expire_in":604800,
  4.         "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoidG9rZW4iLCJ1c2VyX2lkIjoxLCJ0b2tlbl90aW1lIjoxNTA4NDY3NDAyfQ.ps7dPdN6-16ip5f4-fgfBZ5ye9Qu6oH9ADjz0iH1nvs",
  5.         "refresh_token_expire_in":1209600,
  6.         "refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaF90b2tlbiIsInVzZXJfaWQiOjEsInRva2VuX3RpbWUiOjE1MDkwNzIyMDJ9.1r6PRGStReI1YFUrgggCovF5DAiS9gWMBY8DXOi2zPs"
  7.     },
  8.     "code":0
  9. }
参数 类型 说明
token_expire_in 整形 token有效时间（秒）
token 字符串 token
refresh_token_expire_in 整形 refresh_token有效时间（秒）
refresh_token 字符串 refresh_token

获取验证码

GET /api/get_verify_code?account=18888888888

参数 类型 必须 说明
account 字符串 是 手机或邮箱 
  1. {
  2.     "code": 0,
  3.     "message": {
  4.         "verify_code": "123456"
  5.     }
  6. }

修改密码

PUT /api/user/reset_password

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "user_password": "1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "reset_password success"
  4. }

获取用户信息

GET /api/user/message

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": {
  3.         "user_avatar": "",
  4.         "user_message_id": 1,
  5.         "created_at": "2017-10-16T18:00:22.227008",
  6.         "updated_at": "2017-10-16T18:00:22.227059",
  7.         "user_telephone": "18656660930",
  8.         "user_id": 1,
  9.         "user_name": "18656660930",
  10.         "user_email": "",
  11.         "user_sex": 1, 
  12.         "user_birthday": "2017-10-10", 
  13.         "user_city": "shanghai",
  14.         "user_name": "nickname",
  15.     },
  16.     "code": 0
  17. }

更改用户信息

PUT /api/user/message

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "user_avatar": "http://xxx.com/123.jpg",
  3.     "user_sex": 1,
  4.     "user_birthday": "2017-10-10",
  5.     "user_city": "shanghai",
  6.     "user_name": "nickname",
  7. }
参数 类型 必须 说明
user_avatar 字符串 否 图片url
user_sex 整型 否 性别 0:女 1:男
user_birthday 字符串 否 生日
user_city 字符串 否 城市
user_name 字符串 否 昵称

备注：不修改的参数不需要填写

  1. {
  2.     "code":0，
  3.     "message": {
  4.         "created_at": "2017-10-16T18:00:22.227008",
  5.         "updated_at": "2017-10-16T18:00:22.227059",
  6.         "user_id": 1,
  7.         "user_avatar": "http://xxx.com/123.jpg",
  8.         "user_sex": 1, 
  9.         "user_birthday": "2017-10-10", 
  10.         "user_city": "shanghai",
  11.         "user_name": "nickname",
  12.     }
  13. }

上传图片

POST /api/user/img

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
img File 是 图片

备注：请求类型为form-data,允许的图片类型为"png,jpg,git"

  1. {
  2.     "code": 0,
  3.     "message": "http://xxx.com/123.jpg"
  4. }

添加反馈信息

POST /api/user/feedback

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "feedback_title": "标题",
  3.     "feedback_content": "描述",
  4.     "feedback_type": "反馈类型",
  5.     "feedback_device": "设备uuid",
  6.     "feedback_model": "产品类型",
  7.     "feedback_status": "反馈状态"
  8. }
参数 类型 必须 说明
feedback_title 字符串 否 反馈标题
feedback_content 字符串 是 反馈描述
feedback_type 整形 否 反馈类型 0:设备问题,1:app问题
feedback_device 字符串 否 设备uuid
feedback_model 字符串 否 产品类型
feedback_status 整形 否 反馈状态 0:待处理,1:处理中,2:已关闭 
  1. {
  2.     "code": 0,
  3.     "message": {反馈信息}
  4. }

获取反馈信息列表

GET /api/user/feedback?page={PAGE}

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": {
  3.         "total": 1,
  4.         "data": [反馈信息列表],
  5.         "pages": 1,
  6.         "page_size": 20,
  7.         "current_page": 1
  8.     },
  9.     "code": 0
  10. }

获取单个反馈信息

GET /api/user/feedback/{pk}

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
pk 整形 是 反馈主键 feedback_id 
  1. {
  2.     "code": 0,
  3.     "message": {反馈信息}
  4. }

编辑反馈信息

PUT /api/user/feedback/{pk}

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "feedback_title": "标题",
  3.     "feedback_content": "描述",
  4.     "feedback_type": "反馈类型",
  5.     "feedback_device": "设备uuid",
  6.     "feedback_model": "产品类型",
  7.     "feedback_status": "反馈状态"
  8. }
参数 类型 必须 说明
feedback_title 字符串 否 反馈标题
feedback_content 字符串 是 反馈描述
feedback_type 整形 否 反馈类型 0:设备问题,1:app问题
feedback_device 字符串 否 设备uuid
feedback_model 字符串 否 产品类型
feedback_status 整形 否 反馈状态 0:待处理,1:处理中,2:已关闭 
  1. {
  2.     "code": 0,
  3.     "message": {反馈信息}
  4. }

删除反馈信息

DELETE /api/user/feedback/{pk}

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
pk 整形 是 反馈主键 feedback_id 
  1. {
  2.     "code": 0,
  3.     "message": "success"
  4. }

获取反馈回复信息

GET /api/user/feedback_reply/{pk}?page={PAGE}

参数 类型 必须 说明
pk 整形 是 反馈信息主键 feedback_id 
  1. {
  2.     "message": {
  3.         "total": 1,
  4.         "data": [回复信息列表],
  5.         "pages": 1,
  6.         "page_size": 20,
  7.         "current_page": 1
  8.     },
  9.     "code": 0
  10. }

FAQ信息列表

GET /faq?app_id={app_id}&page={PAGE}

参数 类型 必须 说明
app_id 字符串 是 产品唯一ID
page 整形 否 页码 
  1. {
  2.     "meta": {
  3.         "message": "Success.",
  4.         "code": 0
  5.     },
  6.     "data": {
  7.         "total": 1,
  8.         "data": [
  9.             {
  10.                 "faq_id": 2,
  11.                 "faq_title": "aaaa",
  12.                 "faq_content": "ccccc"
  13.             }
  14.         ],
  15.         "pages": 1,
  16.         "page_size": 20,
  17.         "current_page": 1
  18.     }
  19. }

获取轮播图列表

GET /scroll

  1. {
  2.     "message": {
  3.         "total": 1,
  4.         "data": [
  5.             {
  6.                 "scroll_id": 2,
  7.                 "app_id": "3758749b-4a05-492f-b737-08d0c142e3dc",
  8.                 "created_at": "2018-01-22T11:07:24.834000",
  9.                 "updated_at": "2018-01-22T11:07:32.258000",
  10.                 "scroll_picture": "http://img.zcool.cn/community/018d4e554967920000019ae9df1533.jpg@900w_1l_2o_100sh.jpg",
  11.                 "scroll_order": 1,
  12.                 "scroll_jump": "http://baidu.com"
  13.             }
  14.         ],
  15.         "pages": 1,
  16.         "page_size": 20,
  17.         "current_page": 1
  18.     },
  19.     "code": 0
  20. }

查询轮播图

GET /scroll/{scroll_id}

  1. {
  2.     "Authorization" : {admin_token}
  3. }
参数 类型 必须 说明
scroll_id 整形 是 主键 scroll_id

* 请求回调

  1. {
  2.     "message": {
  3.         "scroll_id": 2,
  4.         "app_id": "3758749b-4a05-492f-b737-08d0c142e3dc",
  5.         "created_at": "2018-01-22T11:07:24.834000",
  6.         "updated_at": "2018-01-22T11:07:32.258000",
  7.         "scroll_picture": "http://img.zcool.cn/community/018d4e554967920000019ae9df1533.jpg@900w_1l_2o_100sh.jpg",
  8.         "scroll_order": 1,
  9.         "scroll_jump": "http://baidu.com"
  10.     },
  11.     "code": 0
  12. }

阿里用户认证

GET /sds_check_token?token={TOKEN}

参数 类型 必须 说明
token 字符串 是 用户token 
  1. {
  2.     "code": "1000",
  3.     "msg": "成功",
  4.     "description": "",
  5.     "data": {
  6.         "userId": 1,
  7.         "userNick": "name"
  8.     }
  9. }

天气查询接口

GET /api/weather?city={city}

GET /api/weather?location={location}

参数 类型 必须 说明
city 字符串 否 城市名称 例如：“上海”
location 字符串 否 纬度，经度 例如：“31.22，121.48”

备注：city或location必须填一个

  1. {
  2.     "message": {
  3.         "city": "上海",
  4.         "img": "0",
  5.         "temp": "10",
  6.         "humidity": "43",
  7.         "weather": "晴",
  8.         "aqi": "轻度污染"
  9.     },
  10.     "code": 0
  11. }

获取锁用户列表

GET /api/user/device_user/{device}?type={type}

参数 类型 必须 说明
device 字符串 是 设备id
type 字符串 否 开锁类型，没有该参数则拉取所有用户

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": {
  4.         "total": 0,
  5.         "data": [用户列表],
  6.         "pages": 0,
  7.         "page_size": 20,
  8.         "current_page": 1
  9.     }
  10. }

更新锁用户信息

PUT /api/user/device_user/{device}

  1. {
  2.     "UserId": "1",
  3.     "UserName": "小明",
  4.     "UserType": "1",
  5.     "UserAvatar": "http://xxxxxxxx.xx/xxx.jpg"
  6. }
参数 类型 必须 说明
device 字符串 是 设备id
UserId 字符串 是 锁用户id
UserType 字符串 是 锁用户类型 0:无1密码2:指纹3:卡片4:遥控器5:钥匙
UserName 字符串 否 锁用户昵称
UserAvatar 字符串 否 头像地址

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success"
  4. }

获取锁记录(按天数查询)

GET /api/user/device_days_record?page={page}&device={device}&days={days}

参数 类型 必须 说明
device 字符串 是 设备id
days 整型 是 最近N天
page 整型 否 页数 
  1. {
  2.     {
  3.     "code": 0,
  4.     "message": {
  5.         "total": 0,
  6.         "data": [记录列表],
  7.         "pages": 0,
  8.         "page_size": 20,
  9.         "current_page": 1
  10.     }
  11. }
  12. }

获取锁记录(按类型查询)

GET /api/user/device_type_record?page={page}&device={device}&type={type}

参数 类型 必须 说明
device 字符串 是 设备id
type 整型 是 开锁类型
page 整型 否 页数 
  1. {
  2.     {
  3.     "code": 0,
  4.     "message": {
  5.         "total": 0,
  6.         "data": [记录列表],
  7.         "pages": 0,
  8.         "page_size": 20,
  9.         "current_page": 1
  10.     }
  11. }
  12. }

获取锁记录

GET /api/user/device/record/{device}?page={page}&days={days}&type={type}

参数 类型 必须 说明
device 字符串 是 设备id
type 整型 否 开门类型，默认所有类型
days 整型 否 几天内，默认7天内
page 整型 否 页数，默认第1页 
  1. {
  2.     {
  3.     "code": 0,
  4.     "message": {
  5.         "total": 0,
  6.         "data": [记录列表],
  7.         "pages": 0,
  8.         "page_size": 20,
  9.         "current_page": 1
  10.     }
  11. }
  12. }

报警记录

GET /api/user/device/error_record

参数 类型 必须 说明
device 字符串 是 设备id
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注