API 文档
聚合图床API接口文档,提供图片上传、管理和获取功能
API 介绍
聚合图床API提供了一套完整的接口,允许开发者通过编程方式上传、管理和获取图片。所有API请求都使用HTTPS协议,返回格式为JSON。
快速开始
要使用聚合图床API,您需要:
- 注册聚合图床账户
- 在用户中心获取API密钥
- 在请求头中包含API密钥
- 按照文档调用相应接口
API 密钥
您的API密钥是访问聚合图床API的凭证,请妥善保管。
身份验证
所有API请求都需要在请求头中包含API密钥进行身份验证。
POST
/api/v1/upload
在请求头中添加 Authorization 字段,值为 Bearer YOUR_API_KEY。
// 请求头示例
{
"Authorization": "Bearer sk_test_51Hx7jqK...",
"Content-Type": "multipart/form-data"
}
图片上传
上传图片到指定的图床平台。
POST
/api/v1/upload
上传图片到指定的图床平台,返回图片URL和相关信息。
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| file | File | 必填 | 要上传的图片文件 |
| platform | String | 可选 | 图床平台:baidu, sina, sougou, so |
| quality | Number | 可选 | 图片质量,1-100,默认85 |
响应示例
{
"success": true,
"data": {
"id": "img_123456",
"url": "https://example.com/img/abc123.jpg",
"platform": "baidu",
"size": 2048576,
"width": 1920,
"height": 1080,
"format": "JPEG"
}
}
图片管理
管理和操作已上传的图片。
GET
/api/v1/images
获取用户上传的图片列表。
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| page | Number | 可选 | 页码,默认1 |
| limit | Number | 可选 | 每页数量,默认20,最大100 |
| platform | String | 可选 | 按平台筛选 |
DELETE
/api/v1/images/{id}
删除指定的图片。
路径参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | String | 必填 | 图片ID |
图片获取
获取图片信息和处理图片。
GET
/api/v1/images/{id}
获取指定图片的详细信息。
GET
/api/v1/images/{id}/info
获取图片的元数据信息。
服务状态
获取图床平台的服务状态。
GET
/api/v1/status
获取各图床平台的服务状态和可用性。
响应示例
{
"success": true,
"data": {
"baidu": {
"status": "online",
"response_time": 120
},
"sina": {
"status": "online",
"response_time": 85
},
"sougou": {
"status": "degraded",
"response_time": 210
},
"so": {
"status": "online",
"response_time": 95
}
}
}
错误代码
API可能返回的错误代码和描述。
| 错误代码 | HTTP状态码 | 描述 |
|---|---|---|
| invalid_api_key | 401 | API密钥无效或已过期 |
| rate_limit_exceeded | 429 | 请求频率超出限制 |
| invalid_file_type | 400 | 不支持的文件类型 |
| file_too_large | 400 | 文件大小超过限制 |
| platform_unavailable | 503 | 图床平台暂时不可用 |
| image_not_found | 404 | 图片不存在 |
频率限制
为了保护服务稳定性,API接口设有频率限制。
频率限制说明
免费用户
100 次/小时
基础版用户
1,000 次/小时
专业版用户
10,000 次/小时
企业版用户
无限制
频率限制信息会在响应头中返回:
X-RateLimit-Limit- 每小时允许的请求数X-RateLimit-Remaining- 当前小时内剩余的请求数X-RateLimit-Reset- 限制重置的时间戳