diff --git a/frontend/src/pages/DocsPage.vue b/frontend/src/pages/DocsPage.vue index 9fbc0ae..4413122 100644 --- a/frontend/src/pages/DocsPage.vue +++ b/frontend/src/pages/DocsPage.vue @@ -2,29 +2,105 @@
对外 API + 计费 + 额度(硬配额)一体化。
+完整 API 调用说明与示例,适合直接集成到服务端或脚本。
POST /api/v1/compress/direct 获得二进制输出。402 QUOTA_EXCEEDED,请升级或等待周期重置。X-API-Key 调用压缩接口。Idempotency-Key,避免重复扣费。https://ys.workyai.cn/api/v1X-API-Key(推荐)或 Authorization: Bearer <token>compression_rate 1-100,表示压缩后体积占原图比例,100 为不压缩POST /compress,表单字段:file、compression_rate、
+ max_width、max_height、preserve_metadata
+ curl -X POST \\
-H \"X-API-Key: if_live_xxx\" \\
- -F \"file=@./demo.png\" \\
- -F \"compression_rate=70\" \\
- https://your-domain.com/api/v1/compress/direct -o out.png
+ -F \"file=@./demo.jpg\" \\
+ -F \"compression_rate=20\" \\
+ -F \"max_width=2000\" \\
+ https://ys.workyai.cn/api/v1/compress
+ download_url、saved_percent 与 billing.units_charged。
+ POST /compress/direct,响应头包含原/压缩大小与扣费信息。
+ curl -X POST \\
+ -H \"X-API-Key: if_live_xxx\" \\
+ -F \"file=@./demo.jpg\" \\
+ -F \"compression_rate=20\" \\
+ https://ys.workyai.cn/api/v1/compress/direct -o out.jpg -D headers.txt
+ ImageForge-Original-Size、
+ ImageForge-Compressed-Size、
+ ImageForge-Units-Charged
+ POST /compress/batch,上传多文件后返回任务 ID。
+ curl -X POST \\
+ -H \"X-API-Key: if_live_xxx\" \\
+ -F \"files[]=@./a.jpg\" \\
+ -F \"files[]=@./b.jpg\" \\
+ -F \"compression_rate=30\" \\
+ https://ys.workyai.cn/api/v1/compress/batch
+ GET /compress/tasks/<task_id>,响应包含每个文件的 download_url 和 download_all_url(ZIP)。
+ curl -H \"X-API-Key: if_live_xxx\" \\
+ https://ys.workyai.cn/api/v1/compress/tasks/550e8400-e29b-41d4-a716-446655440200
+ /api/v1 下,需带同样的认证头。
+ curl -H \"X-API-Key: if_live_xxx\" \\
+ -L https://ys.workyai.cn/downloads/<file_id> -o result.jpg
+
+curl -H \"X-API-Key: if_live_xxx\" \\
+ -L https://ys.workyai.cn/downloads/tasks/<task_id> -o batch.zip
+ INVALID_REQUEST:参数或文件不合法(检查格式与字段)QUOTA_EXCEEDED:额度不足(升级套餐或等待周期重置)FORBIDDEN:无权限下载该任务/文件(认证不一致)EMAIL_NOT_VERIFIED:登录用户需先完成邮箱验证docs/api.md。
+ 更完整的字段与响应说明请查看仓库文档:docs/api.md。