{"openapi":"3.1.0","info":{"title":"PiP Studio API","version":"1.0.0","description":"PiP Studio 官网、支付、账户和 Electron 对接接口规范。"},"servers":[{"url":"https://ronnytech.top"}],"paths":{"/api/auth/code":{"post":{"summary":"发送邮箱或短信验证码","requestBody":{"required":true},"responses":{"200":{"description":"验证码已发送"}}}},"/api/auth/register":{"post":{"summary":"邮箱密码注册","requestBody":{"required":true},"responses":{"200":{"description":"注册成功","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"accessToken":{"type":"string"},"refreshToken":{"type":"string"},"expiresInSeconds":{"type":"number"},"clientId":{"type":"string"},"productId":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"displayName":{"type":"string"},"avatarUrl":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","email","createdAt","updatedAt"],"additionalProperties":false},"entitlement":{"type":"object","properties":{"productId":{"type":"string"},"planId":{"type":"string"},"status":{"type":"string","enum":["active","expired","anonymous"]},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"features":{"type":"object","properties":{"maxRecordingMinutes":{"type":"number"},"mp4Export":{"type":"boolean"},"watermark":{"type":"boolean"},"maxCameras":{"type":"number"}},"required":["maxRecordingMinutes","mp4Export","watermark","maxCameras"],"additionalProperties":false},"source":{"type":"string","enum":["default","entitlement"]}},"required":["productId","planId","status","expiresAt","features","source"],"additionalProperties":false}},"required":["accessToken","refreshToken","expiresInSeconds","clientId","productId","user","entitlement"],"additionalProperties":false}}}}}}},"/api/auth/login":{"post":{"summary":"邮箱密码登录","requestBody":{"required":true},"responses":{"200":{"description":"登录成功","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"accessToken":{"type":"string"},"refreshToken":{"type":"string"},"expiresInSeconds":{"type":"number"},"clientId":{"type":"string"},"productId":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"displayName":{"type":"string"},"avatarUrl":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","email","createdAt","updatedAt"],"additionalProperties":false},"entitlement":{"type":"object","properties":{"productId":{"type":"string"},"planId":{"type":"string"},"status":{"type":"string","enum":["active","expired","anonymous"]},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"features":{"type":"object","properties":{"maxRecordingMinutes":{"type":"number"},"mp4Export":{"type":"boolean"},"watermark":{"type":"boolean"},"maxCameras":{"type":"number"}},"required":["maxRecordingMinutes","mp4Export","watermark","maxCameras"],"additionalProperties":false},"source":{"type":"string","enum":["default","entitlement"]}},"required":["productId","planId","status","expiresAt","features","source"],"additionalProperties":false}},"required":["accessToken","refreshToken","expiresInSeconds","clientId","productId","user","entitlement"],"additionalProperties":false}}}}}}},"/api/auth/verify":{"post":{"summary":"验证码登录或注册","requestBody":{"required":true},"responses":{"200":{"description":"验证成功","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"accessToken":{"type":"string"},"refreshToken":{"type":"string"},"expiresInSeconds":{"type":"number"},"clientId":{"type":"string"},"productId":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"displayName":{"type":"string"},"avatarUrl":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","email","createdAt","updatedAt"],"additionalProperties":false},"entitlement":{"type":"object","properties":{"productId":{"type":"string"},"planId":{"type":"string"},"status":{"type":"string","enum":["active","expired","anonymous"]},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"features":{"type":"object","properties":{"maxRecordingMinutes":{"type":"number"},"mp4Export":{"type":"boolean"},"watermark":{"type":"boolean"},"maxCameras":{"type":"number"}},"required":["maxRecordingMinutes","mp4Export","watermark","maxCameras"],"additionalProperties":false},"source":{"type":"string","enum":["default","entitlement"]}},"required":["productId","planId","status","expiresAt","features","source"],"additionalProperties":false}},"required":["accessToken","refreshToken","expiresInSeconds","clientId","productId","user","entitlement"],"additionalProperties":false}}}}}}},"/api/auth/refresh":{"post":{"summary":"刷新访问令牌","requestBody":{"required":true},"responses":{"200":{"description":"刷新成功","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"accessToken":{"type":"string"},"refreshToken":{"type":"string"},"expiresInSeconds":{"type":"number"},"clientId":{"type":"string"},"productId":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"displayName":{"type":"string"},"avatarUrl":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","email","createdAt","updatedAt"],"additionalProperties":false},"entitlement":{"type":"object","properties":{"productId":{"type":"string"},"planId":{"type":"string"},"status":{"type":"string","enum":["active","expired","anonymous"]},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"features":{"type":"object","properties":{"maxRecordingMinutes":{"type":"number"},"mp4Export":{"type":"boolean"},"watermark":{"type":"boolean"},"maxCameras":{"type":"number"}},"required":["maxRecordingMinutes","mp4Export","watermark","maxCameras"],"additionalProperties":false},"source":{"type":"string","enum":["default","entitlement"]}},"required":["productId","planId","status","expiresAt","features","source"],"additionalProperties":false}},"required":["accessToken","refreshToken","expiresInSeconds","clientId","productId","user","entitlement"],"additionalProperties":false}}}}}}},"/api/auth/logout":{"post":{"summary":"退出登录","responses":{"200":{"description":"已退出"}}}},"/api/auth/exchange":{"post":{"summary":"Electron auth_code 换取 token","requestBody":{"required":true},"responses":{"200":{"description":"交换成功","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"accessToken":{"type":"string"},"refreshToken":{"type":"string"},"expiresInSeconds":{"type":"number"},"clientId":{"type":"string"},"productId":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"displayName":{"type":"string"},"avatarUrl":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","email","createdAt","updatedAt"],"additionalProperties":false},"entitlement":{"type":"object","properties":{"productId":{"type":"string"},"planId":{"type":"string"},"status":{"type":"string","enum":["active","expired","anonymous"]},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"features":{"type":"object","properties":{"maxRecordingMinutes":{"type":"number"},"mp4Export":{"type":"boolean"},"watermark":{"type":"boolean"},"maxCameras":{"type":"number"}},"required":["maxRecordingMinutes","mp4Export","watermark","maxCameras"],"additionalProperties":false},"source":{"type":"string","enum":["default","entitlement"]}},"required":["productId","planId","status","expiresAt","features","source"],"additionalProperties":false}},"required":["accessToken","refreshToken","expiresInSeconds","clientId","productId","user","entitlement"],"additionalProperties":false}}}}}}},"/api/auth/oauth/wechat":{"get":{"summary":"跳转微信 OAuth 登录"}},"/api/auth/oauth/wechat/callback":{"get":{"summary":"微信 OAuth 回调"}},"/api/user/me":{"get":{"summary":"获取当前用户信息"},"patch":{"summary":"更新当前用户信息"}},"/api/user/entitlement":{"get":{"summary":"获取当前权益","responses":{"200":{"description":"权益","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"productId":{"type":"string"},"planId":{"type":"string"},"status":{"type":"string","enum":["active","expired","anonymous"]},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"features":{"type":"object","properties":{"maxRecordingMinutes":{"type":"number"},"mp4Export":{"type":"boolean"},"watermark":{"type":"boolean"},"maxCameras":{"type":"number"}},"required":["maxRecordingMinutes","mp4Export","watermark","maxCameras"],"additionalProperties":false},"source":{"type":"string","enum":["default","entitlement"]}},"required":["productId","planId","status","expiresAt","features","source"],"additionalProperties":false}}}}}}},"/api/plans":{"get":{"summary":"获取定价方案","responses":{"200":{"description":"方案列表","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"productId":{"type":"string"},"name":{"type":"string"},"priceCents":{"type":"number"},"currency":{"type":"string"},"interval":{"anyOf":[{"type":"string"},{"type":"null"}]},"tagline":{"type":"string"},"description":{"type":"string"},"features":{"type":"object","properties":{"maxRecordingMinutes":{"type":"number"},"mp4Export":{"type":"boolean"},"watermark":{"type":"boolean"},"maxCameras":{"type":"number"}},"required":["maxRecordingMinutes","mp4Export","watermark","maxCameras"],"additionalProperties":false},"highlights":{"type":"array","items":{"type":"string"}},"ctaLabel":{"type":"string"},"highlighted":{"type":"boolean"}},"required":["id","productId","name","priceCents","currency","interval","tagline","description","features","highlights","ctaLabel","highlighted"],"additionalProperties":false}}}}}}}},"/api/pay/create":{"post":{"summary":"创建支付订单","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"productId":{"type":"string"},"clientId":{"type":"string"},"planId":{"type":"string"},"channel":{"type":"string","enum":["wechat","alipay"]}},"required":["planId","channel"],"additionalProperties":false}}}},"responses":{"200":{"description":"订单创建成功","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"orderId":{"type":"string"},"paymentUrl":{"type":"string"},"qrCodeData":{"type":"string"}},"required":["orderId"],"additionalProperties":false}}}}}}},"/api/pay/status":{"get":{"summary":"查询订单状态"}},"/api/pay/webhook/wechat":{"post":{"summary":"微信支付 webhook"}},"/api/pay/webhook/alipay":{"post":{"summary":"支付宝 webhook"}},"/api/releases/latest":{"get":{"summary":"获取最新下载信息","responses":{"200":{"description":"发布信息","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"productId":{"type":"string"},"version":{"type":"string"},"channel":{"type":"string"},"platform":{"type":"string"},"arch":{"type":"string"},"fileName":{"type":"string"},"fileSize":{"type":"number"},"downloadUrl":{"type":"string"},"releaseNotes":{"type":"string"}},"required":["productId","version","channel","platform","arch","fileName","fileSize","downloadUrl","releaseNotes"],"additionalProperties":false}}}}}}},"/api/openapi.json":{"get":{"summary":"获取 OpenAPI 原始规范"}}}}