本文介绍「长乐未央」API 的基础知识,以及用户认证的方式。

OAuth 2 / API 认证

登录 路径

POST /oauth/token

Parameters

{
    grant_type: 'password',
    client_id: 'RCnGmwJv15EIuTT9tH0VU5LR4XnfTHLS1EZ32svVmEc',
    client_secret: 'oQYcSZ6lbGSk-EusazGBdb7_4e8v2TAWBn9vVmmkD6k',
    username: '',
    password: ''
}

Response

{
    "access_token": "j2xRZXV0GQdnvxAP7SZtz0ii8HMk-1PzeKNp101j2qc",
    "token_type": "Bearer",
    "expires_in": 7776000,
    "refresh_token": "GL1LUXl5JXeryV6UFUqxi_OBmytGGGtD4HzqjnrbELY",
    "created_at": 1589771711
}

Response 说明

所有 Response 采用 JSON 格式返回,请求状态通过 HTTP Status 返回。

HTTP Status

错误的情况 Response Body 一定会是这样的格式: { "error" : "Error message" }

  • 200, 201 - 请求成功,或执行成功。

  • 400 - 参数不符合 API 的要求、或者数据格式验证没有通过,请配合 Response Body 里面的 error 信息确定问题。

  • 401 - 用户认证失败,或缺少认证信息,比如 access_token 过期,或没传,可以尝试用 refresh_token 方式获得新的 access_token。

  • 403 - 当前用户对资源没有操作权限。

  • 404 - 资源不存在。

  • 500 - 服务器异常。

已添加到喜欢了