apidoc.md

v0.0.0

• User
  • 更新手机号码/昵称
  • 获取用户个人信息
  • 获取refresh token
  • 手机号码登录
  • 用户更新个人密码
  • 用户名登录
  • 用户注册

---

User

更新手机号码/昵称

Back to top

POST /venus/user/info

Headers - Header

Name	Type	Description
token	String	Token

Parameters - Parameter

Name	Type	Description
phone_number	String	新手机号码
nickname	String	用户昵称

Success response

Success response - Success 200

Name	Type	Description
success	String	状态码

Success response example

Success response example - Success-Response:

HTTP/1.2 200 OK
{
 "success": "ok"
}

获取用户个人信息

Back to top

GET /venus/user/info

Parameters - Parameter

Name	Type	Description
nickname	String	昵称
avatar	String	头像地址
position	String	职位名称
department_name	String	部门名称
last_login_at_sec	Number	上一次登录时间

Success response example

Success response example - Success-Response:

HTTP/1.2 200 OK
{
 "nickname": "test",
 "avatar": "test",
 "position": "test",
 "department_name": "gov",
 "last_login_at_sec": 111112222331,
 "internal_phone": "10020"
 "role_id": 1,
 "user_id": 1
}

获取refresh token

Back to top

POST /venus/token/refresh

Headers - Header

Name	Type	Description
token	String	Token HTTP/1.2 200 OK { "token": "token" }

手机号码登录

Back to top

POST /venus/auth/user/signin_with_phone

Parameters - Parameter

Name	Type	Description
phone_number	String	手机号码
password	String	密码

Success response

Success response - Success 200

Name	Type	Description
token	String	Token

Error response example

Error response example - Error-Response:

HTTP/1.1 403 Bad Request
{
    "errorCode": 11003,
    "errorMessage": "invalid_oauth_code"
}

用户更新个人密码

Back to top

POST /venus/user/password

Headers - Header

Name	Type	Description
token	String	Token

Parameters - Parameter

Name	Type	Description
password	String	用户密码
confirm_password	String	用户确认密码

Success response

Success response - Success 200

Name	Type	Description
success	String	状态码

Success response example

Success response example - Success-Response:

HTTP/1.2 200 OK
{
 "success": "ok"
}

用户名登录

Back to top

POST /venus/auth/user/signin_with_name

Parameters - Parameter

Name	Type	Description
user_name	String	用户名
password	String	密码

Success response

Success response - Success 200

Name	Type	Description
token	String	Token.

Error response

Error response - Error 4xx

Name	Type	Description
UserNotFound		User not found
InvalidOAuthCode		Invalid Token

Error response example

Error response example - Error-Response:

HTTP/1.1 404 Not Found
{
    "errorCode": 10010,
    "errorMessage": "user_not_found"
}

Error response example - Error-Response:

HTTP/1.1 404 Bad Request
{
    "errorCode": 11003,
    "errorMessage": "invalid_oauth_code"
}

用户注册

Back to top

POST /venus/auth/user/create

Parameters - Parameter

Name	Type	Description
user_name	String	用户名
password	String	密码
nickname	String	昵称
phone_number	String	手机号码
internal_number	String	内部电话号码

Error response

Error response - Error 4xx

Name	Type	Description
UserExists		The user account already exists

Error response example

Error response example - Error-Response:

HTTP/1.1 400 Bad Request
{
   "errorCode": 10011,
   "errorMessage": "user_exists"
}