[关闭]
@cfygaoyang 2018-12-15T07:35:27.000000Z 字数 3416 阅读 416

APP 接口文档

错误码

错误码 信息 描述
10000 通用错误码
10001 invalid account format 账号格式错误
10002 invalid account 账号错误
10003 invalid password 密码错误
10004 invalid token token错误
10005 invalid code 验证码错误
10006 sms server error 短信服务错误
10007 email server error 邮件服务错误
10008 invalid refresh token 刷新token失败
10009 code expired 验证码过期

账号体系

获取验证码

POST /api/auth/send_code

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

校验验证码（验证码登录）

POST /api/auth/check_code

参数 类型 必须 说明
account 字符串 是 手机或邮箱
code 字符串 是 验证码 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23 10:47:16",
  8.         "expires_in": 68400
  9.     }
  10. }

校验手机号

POST /api/auth/check_account

参数 类型 必须 说明
account 字符串 是 手机或邮箱 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "status": 0
  6.     }
  7. }
参数 类型 说明
status 整型 1:已注册, 0:未注册

注册

POST /api/auth/register

参数 类型 必须 说明
account 字符串 是 手机或邮箱
password 字符串 是 密码
code 字符串 是 验证码 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23 10:47:16",
  8.         "expires_in": 68400
  9.     }
  10. }

获取 token

POST /api/auth/access_token

参数 类型 必须 说明
account 字符串 是 手机或邮箱
password 字符串 是 密码 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23 10:47:16",
  8.         "expires_in": 68400
  9.     }
  10. }

刷新 token

POST /api/auth/refresh_token

参数 类型 必须 说明
refresh_token 字符串 是 刷新token 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "access_token": "4kbv6KFHyIJ4JECtFuRLZreHRwDz3Yo6f19fgpu5VYgnSIegN1",
  6.         "refresh_token": "pdgSDcfbZsEijvB1yH6RVGXutQWM4fF5qcCxz033AhaokshiwU",
  7.         "expires_at": "2018-08-23 10:47:16",
  8.         "expires_in": 68400
  9.     }
  10. }

销毁 token

POST /api/auth/destroy_token

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

重置用户名

POST /api/auth/reset_username

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
username 字符串 是 用户名 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

重置密码（token）

POST /api/auth/reset_password

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
password 字符串 是 密码 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

重置密码（account,code,password）

POST /api/auth/reset_password_by_code

参数 类型 必须 说明
account 字符串 是 手机或邮箱
code 字符串 是 验证码
password 字符串 是 密码 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

重置密码（account,old_password,password）

POST /api/auth/reset_password_by_old_password

参数 类型 必须 说明
account 字符串 是 手机或邮箱
old_password 字符串 是 旧密码
password 字符串 是 新密码 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {}
  5. }

用户信息

获取个人信息

GET /api/user

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": null,
  7.         "created_at": "2018-08-22 16:06:00",
  8.         "updated_at": "2018-08-22 16:06:00",
  9.         "avatar": null,
  10.         "birthday": null,
  11.         "sex": 2,
  12.         "city": null,
  13.         "address": null,
  14.         "company": null,
  15.         "job": null,
  16.         "name": null,
  17.         "age": 0,
  18.         "user_id": 4,
  19.         "username": "jerry",
  20.         "phone": "18656660930",
  21.         "email": null
  22.     }
  23. }

编辑个人信息

PUT /api/user

  1. {
  2.     "Authorization": "Token 1234567890"
  3. }
参数 类型 必须 说明
avatar 字符串 可选 头像
birthday 字符串 可选 生日
sex 整型 可选 性别：0女1男2保密
city 字符串 可选 城市
address 字符串 可选 地址
company 字符串 可选 公司
job 字符串 可选 职称
name 字符串 可选 姓名
age 字符串 可选 年龄 
  1. {
  2.     "code": 0,
  3.     "message": "success",
  4.     "data": {
  5.         "id": 1,
  6.         "app_id": null,
  7.         "created_at": "2018-08-22 16:06:00",
  8.         "updated_at": "2018-08-22 16:06:00",
  9.         "avatar": null,
  10.         "birthday": null,
  11.         "sex": 2,
  12.         "city": null,
  13.         "address": null,
  14.         "company": null,
  15.         "job": null,
  16.         "name": null,
  17.         "age": 0,
  18.         "user_id": 4,
  19.         "username": "jerry",
  20.         "phone": "18656660930",
  21.         "email": null
  22.     }
  23. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注