API 参考
凌云海开发者平台提供的公开 API 接口文档。
基本信息
| 项目 | 说明 |
|---|---|
| 基础地址 | https://api.mclinyunhai.com |
| 认证方式 | Bearer Token(Access Token) |
| 数据格式 | JSON |
| 字符编码 | UTF-8 |
授权
生成授权链接
GET /oauth/authorize
将用户重定向到授权页面进行登录和授权。
| 参数 | 位置 | 必填 | 说明 |
|---|---|---|---|
| client_id | Query | 是 | 应用 Client ID |
| redirect_uri | Query | 是 | 回调地址 |
| response_type | Query | 是 | 固定值 code |
| state | Query | 推荐 | 防 CSRF 随机字符串 |
换取 Access Token
POST /oauth/token
使用授权码换取访问令牌。
| 参数 | 位置 | 必填 | 说明 |
|---|---|---|---|
| grant_type | Body | 是 | 固定值 authorization_code |
| code | Body | 是 | 授权码 |
| client_id | Body | 是 | 应用 Client ID |
| client_secret | Body | 是 | 应用 Client Secret |
请求示例:
POST /oauth/token HTTP/1.1
Host: api.mclinyunhai.com
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
&code=abc123...
&client_id=client_xxx
&client_secret=xxx
响应示例:
HTTP/1.1 200 OK
Content-Type: application/json
{
"access_token": "eyJhbGciOiJSUzI1NiIs...",
"token_type": "Bearer",
"expires_in": 3600
}
获取用户信息
GET /oauth/userinfo
使用 Access Token 获取已授权用户的基本信息。
| 参数 | 位置 | 必填 | 说明 |
|---|---|---|---|
| Authorization | Header | 是 | 格式:Bearer {access_token} |
请求示例:
GET /oauth/userinfo HTTP/1.1
Host: api.mclinyunhai.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIs...
响应示例:
HTTP/1.1 200 OK
Content-Type: application/json
{
"sub": "10001",
"nickname": "张三",
"email": "zhangsan@example.com",
"avatar": "https://accounts.mclinyunhai.com/uploads/avatars/10001.jpg"
}
错误处理
API 错误时返回对应的 HTTP 状态码和错误信息:
| 状态码 | 说明 |
|---|---|
| 400 | 请求参数错误 |
| 401 | Access Token 无效或已过期 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 429 | 请求频率过高,请稍后重试 |
| 500 | 服务器内部错误 |
错误响应体中包含
error 和 error_description 字段,提供具体的错误原因。