主题
用 API Key 上传原型
通过组织级 API Key,你可以在脚本或 CI/CD 流水线中直接上传原型的新版本, 无需登录网页。
前置条件
- 已创建组织,并在组织下有一个设计稿(原型),记下其
designId。 - 已创建 API Key,保存了明文
pk_xxxxxxxx_xxxx(仅在创建时显示一次)。 - 一个待上传的 zip 包(原型构建产物,例如前端
dist)。上限 100MB。
请求
http
POST /api/designs/:designId/versions
Authorization: Bearer pk_xxxxxxxx_xxxx
Content-Type: multipart/form-data表单字段:
| 字段 | 必填 | 说明 |
|---|---|---|
file | 是 | zip 包文件(等价别名 zip)。单个 zip 会被自动解压托管。 |
API Key 必须属于该设计稿所在的组织,否则返回 403。
示例(curl)
bash
curl -X POST "https://developer.yunku.live/api/designs/<designId>/versions" \
-H "Authorization: Bearer pk_xxxxxxxx_xxxx" \
-F "file=@./dist.zip"响应
成功返回 HTTP 201,响应体包含新建的版本信息:
json
{
"version": {
"id": "...",
"designId": "...",
"number": 1,
"createdAt": "2026-06-12T00:00:00.000Z"
}
}随后可在网页端预览,或为其创建分享链接。
常见错误
| 状态 | 错误码 | 含义 |
|---|---|---|
| 401 | UNAUTHORIZED | 缺少 Authorization: Bearer,或 API Key 无效 / 已吊销 |
| 403 | FORBIDDEN | API Key 不属于该设计稿所在组织 |
| 404 | NOT_FOUND | designId 不存在 |
| 400 | BAD_REQUEST | 非 multipart/form-data、缺少文件字段、字段数量不一致等 |
| 413 | PAYLOAD_TOO_LARGE | 超出 100MB 上限 |
关于 400 的完整子情形,见 API 参考 / 上传版本。
完整端点参考见 API 参考 / 上传版本。