Skip to content

API 参考

开发者平台 REST API。受保护接口在 /api 前缀下,公开原型托管在 /p 前缀下。 生产基址:https://developer.yunku.live

鉴权

两类令牌,均通过 Authorization: Bearer <token> 携带:

类型取得方式用途
用户 JWT登录(POST /api/auth/login网页 / 桌面端调用受保护接口
API Key在组织下创建(pk_...脚本 / CI 上传原型等

错误模型

错误响应统一格式:

json
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "未认证或令牌无效",
    "details": null
  }
}

HTTP 状态码与错误码对应关系见 错误码

接口分区

分区路径前缀说明
认证/api/auth/...注册、登录、me、OAuth 授权码
组织/api/orgs/...组织创建与详情
成员/api/orgs/:id/members/...组织成员管理
设计稿/api/orgs/:id/designs/api/designs/:id原型 CRUD
版本/api/designs/:id/versions上传原型版本
分享/api/designs/:id/shares/api/shares/:id分享链接管理
API Key/api/orgs/:id/apikeys/api/apikeys/:idAPI Key 管理
设备授权/api/devices/...设备注册与管理
CLI 续期/api/cli/refreshrefresh token 续期
公开托管/p/:shareId/...无需登录访问分享原型