OAuth API 文档
HcBBs OAuth 2.0 API 接口文档
v1.0.0
快速开始
1. 创建应用:访问 HcAuth 创建OAuth应用并获取App ID和App Secret
2. 发起授权:将用户重定向到
https://hcbbs.eu.org/auth?app_id=YOUR_APP_ID3. 获取Token:用户授权后会重定向到你的回调地址,URL中包含access_token
4. 调用API:在请求头中添加
Authorization: Bearer YOUR_ACCESS_TOKEN权限范围
| 权限 | 说明 |
|---|---|
user:read | 读取用户基本信息(ID、用户名、头像、级别) |
user:email | 读取用户邮箱地址 |
profile:read | 读取用户个人资料(简介、统计数据) |
profile:write | 修改用户个人资料 |
threads:read | 读取用户的帖子列表 |
threads:write | 代表用户发布新帖子 |
posts:read | 读取用户的评论列表 |
posts:write | 代表用户发表评论 |
GET
/auth?app_id={APP_ID}发起OAuth授权请求
URL 参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_id | string | 是 | 应用的App ID |
响应示例
重定向到授权页面,用户授权后返回 {REDIRECT_URI}?access_token={TOKEN}&token_type=Bearer&expires_in={SECONDS}请求示例
# 1. 将用户重定向到授权页面 window.location.href = "https://hcbbs.eu.org/auth?app_id=YOUR_APP_ID" # 2. 用户授权后会重定向到你的回调地址 # https://your-app.com/callback?access_token=hc_token_xxx&token_type=Bearer&expires_in=2592000