[关闭]
@cfygaoyang 2018-05-23T09:02:31.000000Z 字数 7368 阅读 864

福玛特 APP接口文档

获取token

GET /api/get_token?account=18888888888&verify_code=123456

GET /api/get_token?account=18888888888&password=123456

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

* 请求回调

  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.         "permission": 0
  8.     },
  9.     "code":0
  10. }
参数 类型 说明
token_expire_in 整形 token有效时间（秒）
token 字符串 token
refresh_token_expire_in 整形 refresh_token有效时间（秒）
refresh_token 字符串 refresh_token

token检查

POST /api/token/check

参数 类型 必须 说明
token 字符串 是 用户token 
  1. {
  2.     "message":""
  3.     "code":0
  4. }
错误码 说明
10005 token过期
10021 缺少token字段

用户已注册检查

POST /check/register

参数 类型 必须 说明
account 字符串 是 手机号 
  1. {
  2.     "message":""
  3.     "code":0
  4. }
错误码 说明
10002 手机号格式不正确
10012 缺少字段
10022 已注册

绑定第三方账号

POST /api/user/open

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "open_id": "sdfghjklertyuio",
  3.     "open_type": 1
  4. }
参数 类型 必须 说明
open_id 字符串 是 第三方账号id
open_type 字符串 是 第三方账号类型: 1.QQ 2.微信 3.微博 4.淘宝 
  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

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

* 请求回调

  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_permission": 0,
  5.         "user_message_id": 1,
  6.         "created_at": "2017-10-16T18:00:22.227008",
  7.         "updated_at": "2017-10-16T18:00:22.227059",
  8.         "user_telephone": "18656660930",
  9.         "user_id": 1,
  10.         "user_name": "18656660930",
  11.         "user_email": "",
  12.         "user_sex": 1, 
  13.         "user_birthday": "2017-10-10", 
  14.         "user_city": "shanghai",
  15.         "user_name": "nickname",
  16.     },
  17.     "code": 0
  18. }

更改用户信息

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_title 字符串 是 反馈标题
feedback_content 字符串 是 反馈描述
feedback_phone 字符串 可选 手机号 
  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_title 字符串 是 反馈标题
feedback_content 字符串 是 反馈描述
feedback_phone 字符串 可选 手机号 
  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?page={PAGE}

  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?page={PAGE}

参数 类型 必须 说明
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 /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 /area

参数 类型 必须 说明 
  1. {
  2.     "message": {
  3.         "status": "1",
  4.         "info": "OK",
  5.         "infocode": "10000",
  6.         "count": "1",
  7.         "districts": [...],
  8.         "suggestion": {
  9.             "keywords": [],
  10.             "cities": []
  11.         }
  12.     },
  13.     "code": 0
  14. }

获取消息状态

GET /api/user/notice/summary

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": {
  3.         "content_notice": "cccc2222",
  4.         "content_notice_time": "2018-04-10",
  5.         "content_reply_time": "2018-04-11",
  6.         "unread_notice": 0,
  7.         "unread_reply": 1,
  8.         "content_reply": "cccc222"
  9.     },
  10.     "code": 0
  11. }

获取活动消息列表

GET /api/user/notice

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "total": 4,
  3.     "data": [
  4.         {
  5.             "id": 2,
  6.             "number": "00000002",
  7.             "title": "ttt",
  8.             "content": "cccc",
  9.             "thumbnail": "",
  10.             "status": 0,
  11.             "created_at": "2018-04-10T13:13:52.330000"
  12.         },
  13.         {
  14.             "id": 3,
  15.             "number": "00000003",
  16.             "title": "ttt222",
  17.             "content": "cccc2222",
  18.             "thumbnail": "",
  19.             "status": 0,
  20.             "created_at": "2018-04-10T13:59:30.147000"
  21.         },
  22.         {
  23.             "id": 4,
  24.             "number": "00000004",
  25.             "title": "tttddd",
  26.             "content": "ddddd",
  27.             "thumbnail": "",
  28.             "status": 0,
  29.             "created_at": "2018-04-10T14:16:15.091000"
  30.         },
  31.         {
  32.             "id": 5,
  33.             "number": "00000005",
  34.             "title": "ttt222",
  35.             "content": "cccc2222",
  36.             "thumbnail": "",
  37.             "status": 0,
  38.             "created_at": "2018-04-10T16:08:15.380000"
  39.         }
  40.     ],
  41.     "pages": 1,
  42.     "page_size": 20,
  43.     "current_page": 1
  44. }

获取活动消息内容

GET /api/user/notice/{pk}

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": {
  3.         "id": 2,
  4.         "number": "00000002",
  5.         "title": "ttt",
  6.         "content": "cccc",
  7.         "thumbnail": "",
  8.         "status": 0,
  9.         "created_at": "2018-04-10T13:13:52.330000"
  10.     },
  11.     "code": 0
  12. }

获取客服消息

GET /api/user/feedback_reply

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": [
  3.         {
  4.             "is_read": 1,
  5.             "feedback_phone": "15618927901",
  6.             "feedback_title": "t3",
  7.             "created_at": "2018-04-10 15:25:10",
  8.             "feedback_id": 3,
  9.             "updated_at": "2018-04-11T17:08:00.647000",
  10.             "reply_id": 4,
  11.             "feedback_status": 2,
  12.             "reply_time": "2018-04-11 17:08:00",
  13.             "user_id": 2,
  14.             "reply_content": "cccc222",
  15.             "feedback_content": "c3"
  16.         }
  17.     ],
  18.     "code": 0
  19. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注