调用 API 前必须先获取 API Key
所有 API 请求均需通过 X-API-Key 请求头进行身份认证。没有有效的 API Key,任何端点都无法调用。
基础信息
- Base URL:
https://imgroute.com/api/v1 - 协议:仅支持 HTTPS
- 认证:X-API-Key 请求头
- 响应格式:JSON
两段式上传流程
ImgRoute API 采用两段式上传流程,确保安全性和稳定性:
第一步:申请预签名
POST /api/v1/upload
向主站申请预签名上传凭证,此步会校验日配额和套餐限制。
请求体
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
file_name | string | 是 | 文件名,如 cat.jpg |
file_size | integer | 是 | 文件大小(字节) |
mime_type | string | 是 | MIME 类型,如 image/jpeg |
width | integer | 是 | 图片宽度(像素) |
height | integer | 是 | 图片高度(像素) |
album_id | string | 否 | 目标相册 ID |
响应
{
"success": true,
"data": {
"upload_url": "https://io.imgroute.com/upload/xxx",
"cdn_url": "https://cdn.imgroute.com/xxx"
}
}
第二步:上传文件
将图片以 multipart/form-data 形式直接 POST 至第一步返回的上传地址。
请求
| 项 | 说明 |
|---|---|
| Method | POST |
| URL | 第一步返回的 upload_url |
| Body | file: 图片二进制内容 |
| 有效期 | 10 分钟 |
列表查询
GET /api/v1/list
查询参数
| 参数 | 类型 | 说明 |
|---|---|---|
album_id | string | 相册 ID,不填则列出根目录 |
page | integer | 页码,默认 1,每页 20 条 |
删除资源
DELETE /api/v1/delete?img={image_id}
DELETE /api/v1/delete?album={album_id}
删除图片或相册(相册会递归删除)。二选一,不可同时传递。
警告:删除操作不可逆,相册一旦删除将无法恢复!
创建相册
POST /api/v1/create_album
请求体
{
"name": "相册名称",
"parent_album": null
}