[关闭]
@cfygaoyang 2019-06-27T07:36:16.000000Z 字数 7873 阅读 437

通版APP接口文档

未分类

错误码说明

错误码 说明
0 成功
10000 通用错误码
10001 数据未查到
10002 访问的路径不存在
10003 该用户没有访问或操作权限
10004 无效的Token, 可能是错误的, 失效的, 用户已被删除
10005 请求字段不合法
10006 用户未注册
10007 密码错误
10008 无效的验证码
10009 用户已注册
10010 短信发送太频繁
10011 短信服务欠费
10012 短信服务其他错误信息
10013 短信服务不可用, 可能是服务变更或参数错误导致
10014 邮件服务不可用, 可能是服务变更或参数错误导致

账号体系

获取验证码

POST /api/auth/send_code

  1. {
  2.     "Content-Type": "application/json; charset=utf-8"
  3. }
参数 类型 必须 说明
area string 否 手机区号
account string 是 手机或邮箱

* 请求回调

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

校验验证码

POST /api/auth/check_code

  1. {
  2.     "Content-Type": "application/json; charset=utf-8"
  3. }
参数 类型 必须 说明
area string 否 手机区号
account string 是 手机或邮箱
code string 是 验证码

* 请求回调

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

注册账号

POST /api/auth/register

  1. {
  2.     "Content-Type": "application/json; charset=utf-8"
  3. }
参数 类型 必须 说明
area string 否 手机区号
account string 是 手机或邮箱
code string 是 验证码
password string 是 密码

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "lRnCFDxpK6PhpT44YaaLMwHmvI97GCIQvxazlNSQC4XxjDBCAV",
  6.         "refresh_token": "aQ4XO33CSez6aSXEaiptgD10NzbWMu42xh3Wvb3YI2pgpD1raD",
  7.         "expires_at": "2019-05-29 18:22:30",
  8.         "expires_in": 604800
  9.     }
  10. }

获取Token

POST /api/auth/access_token

  1. {
  2.     "Content-Type": "application/json; charset=utf-8"
  3. }
参数 类型 必须 说明
area string 否 手机区号
account string 是 手机或邮箱
password string 是 密码

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "lRnCFDxpK6PhpT44YaaLMwHmvI97GCIQvxazlNSQC4XxjDBCAV",
  6.         "refresh_token": "aQ4XO33CSez6aSXEaiptgD10NzbWMu42xh3Wvb3YI2pgpD1raD",
  7.         "expires_at": "2019-05-29 18:22:30",
  8.         "expires_in": 604800
  9.     }
  10. }

刷新Token

POST /api/auth/refresh_token

  1. {
  2.     "Content-Type": "application/json; charset=utf-8"
  3. }
参数 类型 必须 说明
refresh_token string 是 刷新Token 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "lRnCFDxpK6PhpT44YaaLMwHmvI97GCIQvxazlNSQC4XxjDBCAV",
  6.         "refresh_token": "aQ4XO33CSez6aSXEaiptgD10NzbWMu42xh3Wvb3YI2pgpD1raD",
  7.         "expires_at": "2019-05-29 18:22:30",
  8.         "expires_in": 604800
  9.     }
  10. }

销毁Token

POST /api/auth/destroy_token

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

获取个人信息

GET /api/personal/info

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 8,
  6.         "area": "86",
  7.         "phone": "18656660930",
  8.         "email": "",
  9.         "openid": "HuTfdXc8mENtNULFPBVt233cN2gzZ9lKqAcoUKed",
  10.         "role": 0,
  11.         "username": "18656660930",
  12.         "is_active": true,
  13.         "app_id": "",
  14.         "created_at": "2019-05-22 18:20:45",
  15.         "updated_at": "2019-05-22 18:20:45",
  16.         "nickname": "",
  17.         "avatar": "",
  18.         "gender": 2,
  19.         "birthday": "",
  20.         "address": ""
  21.     }
  22. }

编辑个人信息

PUT /api/personal/info

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
nickname string 否 昵称
avatar string 否 头像地址
gender int 否 性别：0女，1男，2保密
birthday string 否 生日: 格式要求示例（1991-03-08）
address string 否 住址

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 8,
  6.         "area": "86",
  7.         "phone": "18656660930",
  8.         "email": "",
  9.         "openid": "HuTfdXc8mENtNULFPBVt233cN2gzZ9lKqAcoUKed",
  10.         "role": 0,
  11.         "username": "18656660930",
  12.         "is_active": true,
  13.         "app_id": "",
  14.         "created_at": "2019-05-22 18:20:45",
  15.         "updated_at": "2019-05-22 18:20:45",
  16.         "nickname": "",
  17.         "avatar": "",
  18.         "gender": 2,
  19.         "birthday": "",
  20.         "address": ""
  21.     }
  22. }

推送服务

同步推送绑定

POST /api/push/bind

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
client_id string 是 客户端ID（第三方推送服务提供）
client_type string 是 客户端类型：android, ios

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 3,
  6.         "app_id": "",
  7.         "created_at": "2019-05-23 15:24:40",
  8.         "updated_at": "2019-05-23 15:24:40",
  9.         "user_id": 8,
  10.         "client_id": "xxxxxxx",
  11.         "client_type": "android",
  12.         "switch": true
  13.     }
  14. }

获取推送开关

GET /api/push/switch/{client_id}

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 3,
  6.         "app_id": "",
  7.         "created_at": "2019-05-23 15:24:40",
  8.         "updated_at": "2019-05-23 15:24:40",
  9.         "user_id": 8,
  10.         "client_id": "xxxxxxx",
  11.         "client_type": "android",
  12.         "switch": true
  13.     }
  14. }

编辑推送开关

PUT /api/push/switch/{client_id}

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
switch boolean 是 推送开关状态

* 请求回调

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

FAQ服务

获取FAQ列表

GET /api/faq

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
page_no int 否 分页数：默认1
page_size int 否 数据量：默认20 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 2,
  12.                 "app_id": "",
  13.                 "created_at": "2019-05-23 18:17:16",
  14.                 "updated_at": "2019-05-23 18:17:16",
  15.                 "title": "标题",
  16.                 "content": "内容",
  17.                 "category": "",
  18.                 "external_link": ""
  19.             }
  20.         ]
  21.     }
  22. }

获取FAQ详情

GET /api/faq/{id}

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": "",
  7.         "created_at": "2019-05-23 18:17:16",
  8.         "updated_at": "2019-05-23 18:17:16",
  9.         "title": "标题",
  10.         "content": "内容",
  11.         "category": "",
  12.         "external_link": ""
  13.     }
  14. }

意见反馈

获取反馈类型列表

GET /api/feedback_category

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
page_no int 否 分页数：默认1
page_size int 否 数据量：默认20 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 1,
  12.                 "app_id": "",
  13.                 "created_at": "2019-05-24 11:28:08",
  14.                 "updated_at": "2019-05-24 11:30:57",
  15.                 "name": "app",
  16.                 "description": "app"
  17.             }
  18.         ]
  19.     }
  20. }

添加意见反馈

POST /api/feedback

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
feedback_content string 是 反馈内容
feedback_category_id int 否 反馈类型ID
contact_phone string 否 联系电话）

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 3,
  6.         "app_id": "",
  7.         "created_at": "2019-05-24 11:48:47",
  8.         "updated_at": "2019-05-24 11:48:47",
  9.         "feedback_content": "反馈内容",
  10.         "feedback_status": 0,
  11.         "feedback_category_id": 1,
  12.         "contact_phone": "18656660930",
  13.         "user_id": 2
  14.     }
  15. }

删除意见反馈

DELETE /api/feedback/{id}

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

获取意见反馈列表

GET /api/feedback

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
page_no int 否 分页数：默认1
page_size int 否 数据量：默认20 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 2,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 3,
  12.                 "app_id": "",
  13.                 "created_at": "2019-05-24 11:48:47",
  14.                 "updated_at": "2019-05-24 11:48:47",
  15.                 "feedback_content": "反馈内容",
  16.                 "feedback_status": 0,
  17.                 "feedback_category_id": 1,
  18.                 "contact_phone": "18656660930",
  19.                 "user_id": 2
  20.             },
  21.             {
  22.                 "id": 2,
  23.                 "app_id": "",
  24.                 "created_at": "2019-05-24 11:47:43",
  25.                 "updated_at": "2019-05-24 11:47:43",
  26.                 "feedback_content": "反馈内容",
  27.                 "feedback_status": 0,
  28.                 "feedback_category_id": 1,
  29.                 "contact_phone": "18656660930",
  30.                 "user_id": 2
  31.             }
  32.         ]
  33.     }
  34. }

获取意见反馈回复内容

GET /api/feedback/reply/{feedback_id}

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 2,
  6.         "app_id": "",
  7.         "created_at": "2019-05-24 14:02:44",
  8.         "updated_at": "2019-05-24 14:02:44",
  9.         "reply_content": "回复内容",
  10.         "manager_id": 2,
  11.         "feedback_id": 3,
  12.         "is_read": false
  13.     }
  14. }

消息服务

获取未读消息数量

GET /api/message/count

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
push_ids list 是 推送id数组/列表，如：[1,2,3]

* 请求回调

  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "push_count": 0,
  6.         "feedback_count": 1
  7.     }
  8. }

获取推送消息日志

GET /api/push/log

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
参数 类型 必须 说明
page_no int 否 分页数：默认1
page_size int 否 数据量：默认20 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 1,
  12.                 "app_id": "",
  13.                 "created_at": "2019-05-30 00:00:00",
  14.                 "updated_at": "2019-05-30 00:00:00",
  15.                 "push_title": "推送测试",
  16.                 "push_body": "推送测试内容",
  17.                 "push_scope": 0,
  18.                 "manager_id": 1,
  19.                 "push_status": 1
  20.             }
  21.         ]
  22.     }
  23. }

获取推送消息详情

GET /api/push/log/{id}

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": "",
  7.         "created_at": "2019-05-30 00:00:00",
  8.         "updated_at": "2019-05-30 00:00:00",
  9.         "push_title": "推送测试",
  10.         "push_body": "推送测试内容",
  11.         "push_scope": 0,
  12.         "manager_id": 1
  13.     }
  14. }

批量删除推送消息

DELETE /api/push/log/delete

  1. {
  2.     "Content-Type": "application/json; charset=utf-8",
  3.     "Authorization": "Token xxxxxx"
  4. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注