Authenticaion

Type	Scenario
user	frontend-backend
app	micro-services
app	3rd parties

REQUEST STANDARD

• 请求地址
• 请求方法
• 请求参数 （名称、位置、可选值、是否必填）
• 请求示例
• 返回示例
• HTTP Status 始终返回 200
• 具体错误代号通过 response.body.code 识别

user auth api

• method: POST
• url: /auth/regist/user
• params

参数	类型	位置	必填	描述
account	String	body	true	email/phone
password	String	body	true	密码

• POST /auth/login/
  • account
  • password

app auth

• app regist
• get user list

RESPOSNE CODES

返回码	说明
-1	服务器异常，建议稍后再试
0	请求成功
40000	会话过期
40001	Token 已过期
40002	手机号或密码错误
40003	参数有误
…

成功返回示例

{
  "code": 0,
  "data": {
    "_id": ""
  }
}

错误返回示例

{
  "code": 40000,
  "message": "会话过期"
}

{
  "code": 40003,
  "message": "参数有误: password"
}

REQUEST STANDARD

• 请求地址
• 请求方法
• 请求参数 （名称、位置、可选值、是否必填）
• 请求示例
• 返回示例
• HTTP Status 始终返回 200
• 具体错误代号通过 response.body.code 识别

示例 1 - Update user info

用户详细属性说明，查阅用户模型

• url /user/:_id

• method PUT

参数	类型	位置	必填	描述
Authorization	String	header	true	Bearer <json web token(前后端交互)>
Content-Type	String	header	true	application/json
x-lang	String	header	false	请求返回语言 zh_CN
x-from	String	header	false	客户端代号 csa_pc
_id	String	path	true	objectId
wxname	String	body	false	微信昵称
preference.lang	String	body	false	en_US

• response success

{
  "code": 0,
  "data": {
    // ...USER SCHEMA
    "avatar": "https://path/to/oss/file.png"
  }
}

• response error

{
  "code": 40001,
  "message": "Token 已过期"
}

示例 2 - User list query

• url _/user/list

• method POST

参数	类型	位置	必填	描述
Authorization	String	header	true	Bearer <json web token>
Content-Type	String	header	true	application/json
x-paginate-no	Number	header	true	1
x-paginate-limit	Number	header	true	10
x-lang	String	header	false	en_US
x-from	String	header	false	客户端代号 csa_pc
wxname	String	body	false	微信昵称
name.en	String	body	false	nickname
name.zh	String	body	false	昵称
account	String	body	false	账号（手机号码）

• response success

{
  "code": 0,
  "data": [
    {
      // User Schema,
      "avatar": "https://path/to/oss/file.png"
    }
  ],
  "paginate": {
    "pageNo": 1, // 当前页码
    "pageLimit": 10, // 单页数量
    "total": 586, // 符合查询条件的数据页数
    "next": 2 // 下一页页码, 客户端可根据此信息确认是否可继续加载
  }
}

• response error

{
  "code": -1,
  "message": "Uncaught error"
}

示例 3 - 微服务之间调用

用户详细属性说明，查阅用户模型

• url /user/:_id

• method PUT

参数	类型	位置	必填	描述
Authorization	String	header	true	Key <应用 key（微服务）>
x-paginate-no	Number	header	false	1
x-paginate-limit	Number	header	false	10
x-lang	String	header	false	请求返回语言 zh_CN
_id	String	path	true	objectId
wxname	String	body	false	微信昵称
preference.lang	String	body	false	en_US