HTTP API 与权限参考

核对基线:main 6df20471d848;重新生成不会导出插件实现。

仅收录主题可能消费的公开 API 与 UC API,不包含控制台/Extension 管理接口。 公开前缀不代表允许任意写入;回调由网关签名,评论凭证由实际提交会话验证。UC API 使用当前用户权限。 以下标注为对照的端点不在市场版合同中,Pro 是否可用仍需核对实际发行包、授权与功能配置。

GET /apis/api.knowsphere.webjing.com/v1alpha1/access/-/check

身份:公开路由,按具体操作校验;范围:市场版合同包含。 检查用户对指定内容的访问权限 operationId:CheckAccess。

参数位置必填类型
typequeryTruestring
namequeryTruestring

响应 default */*:AccessCheckVo。

POST /apis/api.knowsphere.webjing.com/v1alpha1/access/-/comment-session

身份:公开路由,按具体操作校验;范围:市场版合同包含。 匿名评论成功后同步当前内容的访问凭证 operationId:SyncAnonymousCommentAccess。

请求 */*:AnonymousCommentAccessRequest。

GET /apis/api.knowsphere.webjing.com/v1alpha1/access/-/target-preview

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取付费墙目标摘要与相关文章预览 operationId:GetPaywallTargetPreview。

参数位置必填类型
typequeryTruestring
namequeryTruestring
limitqueryFalsestring

响应 default */*:PaywallTargetPreviewVo。

POST /apis/api.knowsphere.webjing.com/v1alpha1/access/-/verify-password

身份:公开路由,按具体操作校验;范围:市场版合同包含。 验证口令,成功后设置 cookie operationId:VerifyPassword。

请求 application/json:PasswordVerifyRequest。

GET /apis/api.knowsphere.webjing.com/v1alpha1/captcha/-/generate

身份:公开路由,按具体操作校验;范围:市场版合同包含。 生成验证码图片 operationId:GenerateCaptcha。

GET /apis/api.knowsphere.webjing.com/v1alpha1/columns

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取已启用专栏列表(自动过滤未启用和已归档专栏) operationId:ListPublicColumns。

响应 default */*:ColumnListResponse。

GET /apis/api.knowsphere.webjing.com/v1alpha1/columns/{name}

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取专栏详情 operationId:GetPublicColumnDetail。

参数位置必填类型
namepathTruestring

响应 default */*:ColumnVo。

GET /apis/api.knowsphere.webjing.com/v1alpha1/columns/{name}/chapters

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取专栏章节列表(仅已发布章节) operationId:ListPublicColumnChapters。

参数位置必填类型
namepathTruestring

响应 default */*:ChapterListResponse。

GET /apis/api.knowsphere.webjing.com/v1alpha1/comment-badges/-/resolve

身份:公开路由,按具体操作校验;范围:市场版合同包含。 按资源名批量解析评论/回复徽章 operationId:ResolveCommentBadgesByQuery。

响应 default */*:CommentBadgeResolveResponse。

POST /apis/api.knowsphere.webjing.com/v1alpha1/comment-badges/-/resolve

身份:公开路由,按具体操作校验;范围:市场版合同包含。 批量解析评论/回复徽章 operationId:ResolveCommentBadges。

请求 */*:CommentBadgeResolveRequest。

响应 default */*:CommentBadgeResolveResponse。

POST /apis/api.knowsphere.webjing.com/v1alpha1/comment-rewards/-/stats

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 批量获取评论打赏统计 operationId:BatchGetCommentRewardStatistics。

请求 */*:BatchStatsRequest。

GET /apis/api.knowsphere.webjing.com/v1alpha1/comment-rewards/{commentName}/stats

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 获取单条评论的打赏统计 operationId:GetCommentRewardStatistics。

参数位置必填类型
commentNamepathTruestring

GET /apis/api.knowsphere.webjing.com/v1alpha1/comments/-/config

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取评论组件配置 operationId:GetCommentConfig。

GET /apis/api.knowsphere.webjing.com/v1alpha1/comments/-/widget-status

身份:公开路由,按具体操作校验;范围:市场版合同包含。 检查 KnowSphere 评论组件是否为当前启用的评论组件 operationId:GetCommentWidgetStatus。

GET /apis/api.knowsphere.webjing.com/v1alpha1/distribution/-/check

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 检查推广码有效性 operationId:CheckPromotionCode。

参数位置必填类型
codequeryTruestring

响应 default */*:PromotionCodeCheckVo。

GET /apis/api.knowsphere.webjing.com/v1alpha1/edition

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取当前插件版本信息 operationId:GetEditionInfo。

响应 default */*:EditionInfoVo。

GET /apis/api.knowsphere.webjing.com/v1alpha1/edition/-/features

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取所有功能的详细状态 operationId:GetAllFeatureStatuses。

响应 default */*:FeatureStatusListVo。

GET /apis/api.knowsphere.webjing.com/v1alpha1/edition/-/upgrade

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 获取升级到 Pro 版本的信息 operationId:GetUpgradeInfo。

响应 default */*:UpgradeInfoVo。

GET /apis/api.knowsphere.webjing.com/v1alpha1/edition/{feature}/features

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取指定功能的详细状态 operationId:GetFeatureStatus。

参数位置必填类型
featurepathTruestring

响应 default */*:FeatureStatusResult。

GET /apis/api.knowsphere.webjing.com/v1alpha1/open-api/-/profile

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 获取当前 API Token 信息 operationId:GetApiAccessProfile。

响应 default */*:ApiAccessProfileVo。

GET /apis/api.knowsphere.webjing.com/v1alpha1/open-api/orders

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 通过 API Token 获取订单列表 operationId:ListOpenApiOrders。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
statusqueryFalsestring
productTypequeryFalsestring
usernamequeryFalsestring
X-KnowSphere-Api-KeyheaderFalsestring

响应 default */*:ApiOrderVoList。

GET /apis/api.knowsphere.webjing.com/v1alpha1/open-api/purchases

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 通过 API Token 获取已购内容列表 operationId:ListOpenApiPurchases。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
targetTypequeryFalsestring
sourcequeryFalsestring
usernamequeryFalsestring
X-KnowSphere-Api-KeyheaderFalsestring

响应 default */*:UserAccessVoList。

GET /apis/api.knowsphere.webjing.com/v1alpha1/open-api/stats/-/overview

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 通过 API Token 获取统计概览 operationId:GetOpenApiStatsOverview。

GET /apis/api.knowsphere.webjing.com/v1alpha1/payment-providers/{providerId}/callback

身份:公开路由,按具体操作校验;范围:市场版合同包含。 处理支付提供方 GET 回调 operationId:HandlePaymentProviderCallbackByGet。

参数位置必填类型
providerIdpathTruestring

POST /apis/api.knowsphere.webjing.com/v1alpha1/payment-providers/{providerId}/callback

身份:公开路由,按具体操作校验;范围:市场版合同包含。 处理支付提供方 POST 回调 operationId:HandlePaymentProviderCallbackByPost。

参数位置必填类型
providerIdpathTruestring

GET /apis/api.knowsphere.webjing.com/v1alpha1/paywall/-/target-preview

身份:公开路由,按具体操作校验;范围:市场版合同包含。 获取付费墙目标摘要与相关文章预览(公开路由) operationId:GetPaywallTargetPreviewPublic。

参数位置必填类型
typequeryTruestring
namequeryTruestring
limitqueryFalsestring

响应 default */*:PaywallTargetPreviewVo。

GET /apis/api.knowsphere.webjing.com/v1alpha1/ratings/-/reviews

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 分页获取审核通过的文字评价 operationId:ListApprovedContentRatingReviews。

参数位置必填类型
contentTypequeryTruestring
contentNamequeryTruestring
pagequeryFalsestring
sizequeryFalsestring

GET /apis/api.knowsphere.webjing.com/v1alpha1/ratings/-/stats

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 获取内容评分统计 operationId:GetContentRatingStatistics。

参数位置必填类型
contentTypequeryTruestring
contentNamequeryTruestring

GET /apis/api.knowsphere.webjing.com/v1alpha1/ratings/-/top

身份:公开路由,按具体操作校验;范围:main/Pro 对照,市场版不包含。 获取评分 Top 列表 operationId:ListTopRatedContent。

参数位置必填类型
contentTypequeryFalsestring
limitqueryFalsestring

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/activity-gifts/-/claims

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的活动礼包领取记录 operationId:ListMyActivityGiftClaims。

响应 default */*:Array<GiftClaimRecord>。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/activity-gifts/-/overview

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的待领取活动和领取记录 operationId:GetMyActivityGiftOverview。

响应 default */*:UcActivityGiftOverviewVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/activity-gifts/{name}/claim

身份:当前登录用户;范围:市场版合同包含。 领取指定活动礼包 operationId:ClaimActivityGift。

参数位置必填类型
namepathTruestring

响应 default */*:GiftClaimResultVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/author-contents/-/mine

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户绑定的作者内容 operationId:ListMyAuthorContents。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
targetTypequeryFalsestring
targetNamequeryFalsestring
authorProfileNamequeryFalsestring
rolequeryFalsestring
keywordqueryFalsestring

响应 default */*:AuthorUcEndpoint.AuthorContentItemList。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/author-profile/-/mine

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户的作者档案 operationId:GetMyAuthorProfile。

响应 default */*:AuthorProfileView。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/author-revenues/-/mine

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户的作者收益 operationId:ListMyAuthorRevenues。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
keywordqueryFalsestring
authorProfileNamequeryFalsestring
targetTypequeryFalsestring
phasequeryFalsestring
sourceTypequeryFalsestring

响应 default */*:AuthorUcEndpoint.AuthorRevenueItemList。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/checkin

身份:当前登录用户;范围:市场版合同包含。 执行每日签到 operationId:DoCheckin。

响应 default */*:CheckinResultVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/checkin/status

身份:当前登录用户;范围:市场版合同包含。 获取当前用户签到状态 operationId:GetMyCheckinStatus。

响应 default */*:CheckinStatusVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/columns/-/purchased

身份:当前登录用户;范围:市场版合同包含。 获取用户已购专栏列表 operationId:ListPurchasedColumns。

响应 default */*:PurchasedColumnListResponse。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/columns/{name}/drip-status

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取用户在指定专栏的滴灌解锁状态 operationId:GetColumnDripStatus。

参数位置必填类型
namepathTruestring

响应 default */*:UserDripStatusVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/columns/{name}/progress

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取用户对指定专栏的学习进度 operationId:GetColumnProgress。

参数位置必填类型
namepathTruestring

响应 default */*:UserProgressVo。

PUT /apis/uc.api.knowsphere.webjing.com/v1alpha1/columns/{name}/progress

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 更新用户学习进度 operationId:UpdateColumnProgress。

参数位置必填类型
namepathTruestring

请求 */*:UpdateProgressRequest。

响应 default */*:UserProgressVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/comment-rewards

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 发起打赏(创建订单) operationId:CreateCommentReward。

请求 */*:CreateRewardRequest。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/comment-rewards/-/my

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 查询我的打赏记录 operationId:ListMyCommentRewards。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
commentNamequeryFalsestring

响应 default */*:CommentRewardVoList。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/coupons

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的优惠券列表 operationId:ListMyCoupons。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/coupons/-/available

身份:当前登录用户;范围:市场版合同包含。 获取当前订单场景可用的优惠券列表 operationId:ListAvailableCoupons。

参数位置必填类型
productTypequeryFalsestring
amountqueryFalsestring

响应 default */*:string。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/dashboard-preference

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的个人中心入口排序偏好 operationId:GetMyDashboardPreference。

响应 default */*:DashboardPreferenceResponse。

PUT /apis/uc.api.knowsphere.webjing.com/v1alpha1/dashboard-preference

身份:当前登录用户;范围:市场版合同包含。 更新当前用户的个人中心入口排序偏好 operationId:UpdateMyDashboardPreference。

请求 */*:DashboardPreferenceRequest。

响应 default */*:DashboardPreferenceResponse。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/distribution/-/bind

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 绑定推广关系 operationId:BindDistribution。

请求 */*:BindDistributorRequest。

响应 default */*:BindDistributorResponse。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/distribution/-/settings

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取分销系统设置 operationId:GetDistributionSettings。

响应 default */*:DistributionSettingsVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/distributors/-/apply

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 申请成为分销员 operationId:ApplyDistributor。

请求 */*:DistributorApplyRequest。

响应 default */*:Distributor。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/distributors/-/commissions

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户的佣金明细 operationId:ListMyCommissions。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
phasequeryFalsestring

响应 default */*:DistributionVoList。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/distributors/-/profile

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户的分销员信息 operationId:GetDistributorProfile。

响应 default */*:DistributorVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/distributors/-/statistics

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户的分销统计数据 operationId:GetMyDistributorStatistics。

响应 default */*:DistributionStatisticsVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/distributors/-/team

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户的团队成员 operationId:ListMyTeam。

响应 default */*:TeamMemberListVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/distributors/-/withdraw

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 申请提现 operationId:ApplyWithdraw。

请求 */*:WithdrawApplyRequest。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/distributors/-/withdrawals

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户的提现记录 operationId:ListMyWithdrawals。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/exchange-orders

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取我的兑换订单列表 operationId:ListMyExchangeOrders。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>

响应 default */*:ExchangeOrderVoList。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/exchange-orders

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 兑换商品 operationId:ExchangeProduct。

请求 */*:ExchangeRequest。

响应 default */*:ExchangeOrderVo。

PUT /apis/uc.api.knowsphere.webjing.com/v1alpha1/exchange-orders/{name}/confirm

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 确认收货 operationId:ConfirmReceipt。

参数位置必填类型
namepathTruestring

响应 default */*:ExchangeOrderVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/featuresettings

身份:当前登录用户;范围:市场版合同包含。 获取用户中心可见的 Pro 功能设置 operationId:GetUcFeatureSettings。

响应 default */*:FeatureSettingsResponse。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/membership

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的会员状态 operationId:GetMyMembership。

响应 default */*:MembershipVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/membership/plans

身份:当前登录用户;范围:市场版合同包含。 获取当前用户可见的会员套餐列表 operationId:ListMembershipPlansForUser。

响应 default */*:MembershipPlanListVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/orders

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的订单列表 operationId:ListMyOrders。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
statusqueryFalsestring
productTypequeryFalsestring
usernamequeryFalsestring

响应 default */*:OrderVoList。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/orders

身份:当前登录用户;范围:市场版合同包含。 创建订单 operationId:CreateOrder。

请求 */*:CreateOrderRequest。

响应 default */*:OrderVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/orders/{orderNo}

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的订单详情 operationId:GetMyOrder。

参数位置必填类型
orderNopathTruestring

响应 default */*:OrderVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/orders/{orderNo}/cancel

身份:当前登录用户;范围:市场版合同包含。 取消当前用户的待支付订单 operationId:CancelOrder。

参数位置必填类型
orderNopathTruestring

响应 default */*:OrderVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/orders/{orderNo}/payments

身份:当前登录用户;范围:市场版合同包含。 发起订单支付 operationId:InitiateOrderPayment。

参数位置必填类型
orderNopathTruestring

请求 */*:InitiatePaymentRequest。

响应 default */*:PaymentInitVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/paid-qa-questions

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 创建付费问答问题 operationId:CreatePaidQaQuestion。

请求 */*:CreateQuestionRequest。

响应 default */*:QuestionCreateResultVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/paid-qa-questions/-/my

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取我的问答列表 operationId:ListMyPaidQaQuestions。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
statusqueryFalsestring
askerqueryFalsestring
answererqueryFalsestring
keywordqueryFalsestring
startTimequeryFalsestring
endTimequeryFalsestring

响应 default */*:QuestionVoList。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/paid-qa-questions/-/watchable

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取可围观问题列表 operationId:ListPaidQaQuestions_1。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
statusqueryFalsestring
askerqueryFalsestring
answererqueryFalsestring
keywordqueryFalsestring
startTimequeryFalsestring
endTimequeryFalsestring

响应 default */*:QuestionVoList。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/paid-qa-questions/{name}

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取问题详情(用户端) operationId:GetPaidQaQuestionForUser。

参数位置必填类型
namepathTruestring

响应 default */*:QuestionVo。

PUT /apis/uc.api.knowsphere.webjing.com/v1alpha1/paid-qa-questions/{name}

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 编辑我的问题 operationId:UpdateMyPaidQaQuestion。

参数位置必填类型
namepathTruestring

请求 */*:UpdateQuestionRequest。

响应 default */*:QuestionVo。

PUT /apis/uc.api.knowsphere.webjing.com/v1alpha1/paid-qa-questions/{name}/accept

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 采纳回答 operationId:AcceptPaidQaAnswer。

参数位置必填类型
namepathTruestring

响应 default */*:QuestionVo。

PUT /apis/uc.api.knowsphere.webjing.com/v1alpha1/paid-qa-questions/{name}/close

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 关闭我的问题 operationId:CloseMyPaidQaQuestion。

参数位置必填类型
namepathTruestring

响应 default */*:QuestionVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/paid-qa-questions/{name}/watch

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 创建围观订单 operationId:CreatePaidQaWatchOrder。

参数位置必填类型
namepathTruestring

响应 default */*:OrderVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/payments/-/methods

身份:当前登录用户;范围:市场版合同包含。 获取当前可用的支付方式列表 operationId:ListAvailablePaymentMethods。

响应 default */*:PaymentMethodVoList。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/payments/{orderNo}/status

身份:当前登录用户;范围:市场版合同包含。 查询订单支付状态 operationId:GetOrderPaymentStatus。

参数位置必填类型
orderNopathTruestring

响应 default */*:PaymentStatusVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/products

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取积分商城商品列表(用户端) operationId:ListMallProductsForUser。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
productTypequeryFalsestring

响应 default */*:MallProductVoList。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/products/{name}

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取商品详情(用户端) operationId:GetMallProductForUser。

参数位置必填类型
namepathTruestring

响应 default */*:MallProductVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/purchases

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的已购内容列表 operationId:ListMyPurchases。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
targetTypequeryFalsestring
sourcequeryFalsestring
usernamequeryFalsestring

响应 default */*:UserAccessVoList。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/ratings

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 提交或更新评分 operationId:SubmitContentRating。

请求 */*:SubmitRatingRequest。

DELETE /apis/uc.api.knowsphere.webjing.com/v1alpha1/ratings/-/my

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 删除自己的评分 operationId:DeleteUserContentRating。

参数位置必填类型
contentTypequeryTruestring
contentNamequeryTruestring

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/ratings/-/my

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 查询自己的评分 operationId:GetUserContentRating。

参数位置必填类型
contentTypequeryTruestring
contentNamequeryTruestring

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/tasks

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 获取当前用户可用的任务列表 operationId:ListMyTasks。

响应 default */*:TaskListVo。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/tasks/{taskName}/claim

身份:当前登录用户;范围:main/Pro 对照,市场版不包含。 领取任务奖励 operationId:ClaimTaskReward。

参数位置必填类型
taskNamepathTruestring

响应 default */*:ClaimRewardVo。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/wallet

身份:当前登录用户;范围:市场版合同包含。 获取或创建当前用户的钱包 operationId:GetOrCreateMyWallet。

POST /apis/uc.api.knowsphere.webjing.com/v1alpha1/wallet/recharge

身份:当前登录用户;范围:市场版合同包含。 使用卡密充值 operationId:RechargeByCard。

请求 */*:RechargeRequest。

GET /apis/uc.api.knowsphere.webjing.com/v1alpha1/wallet/transactions

身份:当前登录用户;范围:市场版合同包含。 获取当前用户的钱包交易记录 operationId:ListMyTransactions。

参数位置必填类型
pagequeryFalseinteger:int32
sizequeryFalseinteger:int32
labelSelectorqueryFalseArray<string>
fieldSelectorqueryFalseArray<string>
sortqueryFalseArray<string>
typequeryFalsestring
usernamequeryFalsestring

响应 default */*:WalletTransactionList。

请求与响应模型

字段只来自上述路由引用的模型;金额与身份仍以服务端校验为准。

模型 AccessCheckVo

字段类型必填说明
grantedBystringFalse授权方式类型(granted 时有值,标识哪种解锁方式放行)
hasAccessbooleanFalse是否有访问权限
previewLengthinteger:int32False试看字数
previewRatiointeger:int32False试看比例 0-100
purchaseTargetNamestringFalse下单/购买应使用的目标名称
purchaseTargetTypestringFalse下单/购买应使用的目标类型
resolvedTargetNamestringFalse命中的规则目标名称
resolvedTargetTypestringFalse命中的规则目标类型
unlockMethodsArray<UnlockMethodVo>False可用的解锁方式列表(拒绝时返回)

模型 ActivityGiftStatusVo

字段类型必填说明
campaignNamestringFalse
claimPhasestringFalse
claimTimestring:date-timeFalse
claimedbooleanFalse
coverstringFalse礼包宣传图地址,可为空
descriptionstringFalse
displayNamestringFalse
distributionModestringFalse
eligiblebooleanFalse
endTimestring:date-timeFalse
giftItemsArray<GiftItem>False
startTimestring:date-timeFalse
timeStatusstringFalse

模型 AnonymousCommentAccessRequest

字段类型必填说明
emailstringFalse
namestringFalse
typestringFalse

模型 ApiAccessProfileVo

字段类型必填说明
displayNamestringFalse密钥显示名称
expiresAtstring:date-timeFalse过期时间
namestringFalse密钥名称
scopesArray<string>False授权范围

模型 ApiOrderVo

字段类型必填说明
amountnumberFalse订单金额
completedAtstring:date-timeFalse完成时间
createdAtstring:date-timeFalse创建时间
discountAmountnumberFalse优惠金额
namestringFalse资源名称
orderNostringFalse订单号
paidAmountnumberFalse实付金额
paidAtstring:date-timeFalse支付时间
paymentChannelstringFalse支付渠道
phasestringFalse订单状态
productIdstringFalse商品标识
productTitlestringFalse商品标题
productTypestringFalse商品类型
usernamestringFalse用户名

模型 ApiOrderVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<ApiOrderVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 AuthorContentItem

字段类型必填说明
bindingNamestringFalse
createdAtstring:date-timeFalse
previewPathstringFalse
rolestringFalse
targetDisplayNamestringFalse
targetNamestringFalse
targetTypestringFalse

模型 AuthorDisplayVo

字段类型必填说明
authorProfileNamestringFalse作者档案名称
authorTypestringFalse作者类型
avatarstringFalse头像
biostringFalse简介
displayNamestringFalse展示名
displayOrderinteger:int32False展示顺序
primarybooleanFalse是否主作者
rolestringFalse角色
titlestringFalse头衔
usernamestringFalse内部作者用户名
virtualBindingbooleanFalse是否为旧字段回退生成的虚拟绑定

模型 AuthorProfileView

字段类型必填说明
avatarstringFalse
biostringFalse
displayNamestringFalse
namestringFalse
slugstringFalse
titlestringFalse

模型 AuthorRevenueItem

字段类型必填说明
createdAtstring:date-timeFalse
orderNamestringFalse
phasestringFalse
previewPathstringFalse
recordNamestringFalse
settleAmountnumberFalse
snapshotAuthorDisplayNamestringFalse
snapshotRolestringFalse
sourceTypestringFalse
targetDisplayNamestringFalse
targetNamestringFalse
targetTypestringFalse

模型 AuthorUcEndpoint.AuthorContentItemList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<AuthorContentItem>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 AuthorUcEndpoint.AuthorRevenueItemList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<AuthorRevenueItem>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 BatchStatsRequest

字段类型必填说明
commentNamesArray<string>False

模型 BindDistributorRequest

字段类型必填说明
productIdstringFalse
productTypestringFalse
promotionCodestringFalse
sourcestringFalse

模型 BindDistributorResponse

字段类型必填说明
distributorUsernamestringFalse
messagestringFalse
successbooleanFalse

模型 ChapterDripItem

字段类型必填说明
chapterNamestringFalse
chapterTitlestringFalse
dripStatusstringFalse
unlockTimestring:date-timeFalse

模型 ChapterListResponse

字段类型必填说明
itemsArray<ChapterVo>False
totalinteger:int32False

模型 ChapterVo

字段类型必填说明
authorUsernamestringFalse
dripStatusstringFalse
isFreePreviewbooleanFalse
isPendingUnlockbooleanFalse
isReadbooleanFalse
namestringFalse
permalinkstringFalse
priorityinteger:int32False
publishTimestring:date-timeFalse
publishedbooleanFalse
slugstringFalse
tagsArray<string>False
titlestringFalse
unlockTimestring:date-timeFalse

模型 CheckinResultVo

字段类型必填说明
bonusinteger:int32False连续签到额外奖励积分
consecutiveDaysinteger:int32False连续签到天数
pointsinteger:int32False本次获得积分

模型 CheckinStatusVo

字段类型必填说明
checkedDaysArray<integer:int32>False当月已签到日期列表
checkinPointsinteger:int32False每日签到基础积分
consecutiveDaysinteger:int32False连续签到天数
continuousBonusinteger:int32False连续签到每日额外加成
todayCheckedbooleanFalse今日是否已签到

模型 ClaimRewardVo

字段类型必填说明
messagestringFalse提示消息
rewardTypestringFalse奖励类型
rewardValuestringFalse奖励值
successbooleanFalse是否成功

模型 ColumnListResponse

字段类型必填说明
itemsArray<ColumnVo>False
totalinteger:int32False

模型 ColumnVo

字段类型必填说明
allowChapterPurchasebooleanFalse
articleCountinteger:int32False
authorUsernamestringFalse
authorsArray<AuthorDisplayVo>False
categoryDisplayNamestringFalse
categoryNamestringFalse
chapterPricenumberFalse
coverstringFalse
descriptionstringFalse
displayNamestringFalse
dripEnabledbooleanFalse
enabledbooleanFalse
namestringFalse
originalPricenumberFalse
phasestringFalse
pricenumberFalse
sortOrderinteger:int32False
subscriberCountinteger:int32False
totalViewsinteger:int64False

模型 CommentBadgeResolveItem

字段类型必填说明
anonymousEmailHashstringFalse
resourceNamestringFalse
userIdstringFalse

模型 CommentBadgeResolveRequest

字段类型必填说明
itemsArray<CommentBadgeResolveItem>False

模型 CommentBadgeResolveResponse

字段类型必填说明
badgesobjectFalse

模型 CommentRewardVo

字段类型必填说明
amountnumberFalse
commentNamestringFalse
commentOwnerstringFalse
commentSnippetstringFalse
createdAtstring:date-timeFalse
namestringFalse
orderNamestringFalse
statusstringFalse

模型 CommentRewardVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<CommentRewardVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 CreateOrderRequest

字段类型必填说明
couponNamestringFalse优惠券名称
productIdstringTrue商品ID/名称
productTitlestringFalse商品标题
productTypestringTrue商品类型

模型 CreateQuestionRequest

字段类型必填说明
allowWatchbooleanFalse
contentstringFalse
pricenumberFalse
titlestringFalse
watchPricenumberFalse

模型 CreateRewardRequest

字段类型必填说明
amountnumberFalse
commentNamestringFalse

模型 DashboardPreferenceRequest

字段类型必填说明
consoleModuleOrderArray<string>False
displayPreferencesobjectFalse
layoutPreferencesobjectFalse
ucEntryOrderArray<string>False

模型 DashboardPreferenceResponse

字段类型必填说明
consoleModuleOrderArray<string>False
displayPreferencesobjectFalse
layoutPreferencesobjectFalse
ucEntryOrderArray<string>False

模型 DistributedItem

字段类型必填说明
descriptionstringFalse权益描述快照
errorMessagestringFalse错误信息
rewardTypestringFalse奖励类型
rewardValuestringFalse奖励值
successbooleanFalse是否成功

模型 DistributionSettingsVo

字段类型必填说明
applyConditionstringFalse
enabledbooleanFalse
level1RatenumberFalse
level2RatenumberFalse
minWithdrawAmountnumberFalse
settlementDelayDaysinteger:int32False
withdrawMethodsArray<string>False

模型 DistributionStatisticsVo

字段类型必填说明
directCountinteger:int32False
monthCommissionnumberFalse
orderCountinteger:int32False
pendingCommissionnumberFalse
teamCountinteger:int32False
todayCommissionnumberFalse
todayNewCountinteger:int32False
totalCommissionnumberFalse
withdrawnAmountnumberFalse

模型 DistributionVo

字段类型必填说明
buyerDisplayNamestringFalse
buyerUsernamestringFalse
createdAtstring:date-timeFalse
level1CommissionnumberFalse
level1UsernamestringFalse
level2CommissionnumberFalse
level2UsernamestringFalse
namestringFalse
orderAmountnumberFalse
orderNostringFalse
phasestringFalse
productTitlestringFalse
productTypestringFalse
settledAtstring:date-timeFalse

模型 DistributionVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<DistributionVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 Distributor

字段类型必填说明
apiVersionstringTrue
approvedbooleanFalse
availableBalancenumberFalse
disabledbooleanFalse
kindstringTrue
levelOrDefaultstringFalse
metadataMetadataTrue
pendingbooleanFalse
rejectedbooleanFalse
specDistributorSpecTrue
statusDistributorStatusFalse
statusOrDefaultDistributorStatusFalse

模型 DistributorApplyRequest

字段类型必填说明
applyReasonstringFalse
contactInfostringFalse
promotionCodestringFalse
realNamestringFalse

模型 DistributorSpec

字段类型必填说明
applyReasonstringFalse申请理由
contactInfostringFalse联系方式
levelstringFalse分销员等级
parentUsernamestringFalse上级分销员用户名
promotionCodestringTrue推广码(唯一)
realNamestringFalse真实姓名(提现用)
rejectReasonstringFalse拒绝理由
usernamestringTrue用户名

模型 DistributorStatus

字段类型必填说明
approvedAtstring:date-timeFalse审核通过时间
directCountinteger:int32False直推人数
orderCountinteger:int32False推广订单数
pendingCommissionnumberFalse待结算佣金
phasestringFalse状态
rejectedAtstring:date-timeFalse审核拒绝时间
teamCountinteger:int32False团队总人数
totalCommissionnumberFalse累计佣金
withdrawnAmountnumberFalse已提现金额

模型 DistributorVo

字段类型必填说明
applyReasonstringFalse
approvedAtstring:date-timeFalse
avatarstringFalse
contactInfostringFalse
createdAtstring:date-timeFalse
directCountinteger:int32False
displayNamestringFalse
levelstringFalse
namestringFalse
orderCountinteger:int32False
parentUsernamestringFalse
pendingCommissionnumberFalse
phasestringFalse
promotionCodestringFalse
realNamestringFalse
rejectReasonstringFalse
teamCountinteger:int32False
totalCommissionnumberFalse
usernamestringFalse
withdrawnAmountnumberFalse

模型 EditionInfoVo

字段类型必填说明
displayNamestringFalse
editionstringFalse
featuresArray<string>False
probooleanFalse

模型 ExchangeOrderVo

字段类型必填说明
completedAtstring:date-timeFalse完成时间
createdAtstring:date-timeFalse创建时间
namestringFalse订单名称(唯一标识)
orderNostringFalse订单号
phasestringFalse订单状态
pointsSpentinteger:int32False消耗积分
productDisplayNamestringFalse商品显示名称
productNamestringFalse商品名称(Extension name)
productTypestringFalse商品类型
shippedAtstring:date-timeFalse发货时间
shippingAddressShippingAddressVoFalse
shippingCompanystringFalse快递公司
trackingNumberstringFalse快递单号
usernamestringFalse用户名

模型 ExchangeOrderVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<ExchangeOrderVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 ExchangeRequest

字段类型必填说明
productNamestringFalse
shippingAddressShippingAddressFalse

模型 FeatureGroupVo

字段类型必填说明
enabledCountinteger:int32False
featuresArray<string>False
idstringFalse
namestringFalse
totalCountinteger:int32False

模型 FeatureInfo

字段类型必填说明
availablebooleanFalse
dependenciesArray<string>False
dependentsArray<string>False
descriptionstringFalse
enabledbooleanFalse
groupstringFalse
idstringFalse
namestringFalse
proOnlybooleanFalse
unavailableReasonstringFalse

模型 FeatureSettingsResponse

字段类型必填说明
editionstringFalse
featuresArray<FeatureInfo>False
groupsArray<FeatureGroupVo>False
probooleanFalse

模型 FeatureStatusListVo

字段类型必填说明
editionstringFalse
featuresArray<FeatureStatusResult>False
probooleanFalse

模型 FeatureStatusResult

字段类型必填说明
availablebooleanFalse
featurestringFalse
infoFeatureInfoFalse
reasonstringFalse
statusstringFalse
upgradeUrlstringFalse

模型 GiftClaimRecord

字段类型必填说明
allSuccessbooleanFalse
apiVersionstringTrue
kindstringTrue
metadataMetadataTrue
partialSuccessbooleanFalse
specGiftClaimRecordSpecTrue
statusGiftClaimRecordStatusFalse
statusOrDefaultGiftClaimRecordStatusFalse
userClaimKeystringFalse

模型 GiftClaimRecordSpec

字段类型必填说明
campaignDescriptionstringFalse领取时的活动描述
campaignDisplayNamestringFalse领取时的活动名称
campaignEndTimestring:date-timeFalse领取时的活动结束时间
campaignNamestringFalse活动标识(GiftPackage Extension name)
campaignStartTimestring:date-timeFalse领取时的活动开始时间
claimTimestring:date-timeFalse领取时间
distributedItemsArray<DistributedItem>False已发放项目
usernamestringTrue用户名

模型 GiftClaimRecordStatus

字段类型必填说明
completedAtstring:date-timeFalse完成时间
failedItemsArray<string>False失败项目列表
phasestringFalse领取状态

模型 GiftClaimResultVo

字段类型必填说明
distributedItemsArray<DistributedItem>False已发放项目
messagestringFalse消息
phasestringFalse领取状态
successbooleanFalse是否成功

模型 GiftItem

字段类型必填说明
descriptionstringFalse项目描述
rewardTypestringFalse奖励类型
rewardValuestringFalse奖励值(优惠券名称/积分数/天数)

模型 InitiatePaymentRequest

字段类型必填说明
paymentMethodstringTrue支付方式 ID
returnUrlstringFalse支付完成后的返回地址
scenestringFalse支付场景

模型 MallProductVo

字段类型必填说明
coverstringFalse封面图片
createdAtstring:date-timeFalse创建时间
descriptionstringFalse商品描述
displayNamestringFalse商品显示名称
enabledbooleanFalse是否启用
exchangeLimitinteger:int32False每人兑换上限
imagesArray<string>False商品图片
namestringFalse商品名称(唯一标识)
outOfStockbooleanFalse是否售罄
pointsCostinteger:int32False所需积分
productTypestringFalse商品类型
remainingStockinteger:int32False剩余库存
rewardTypestringFalse奖励类型
rewardValuestringFalse奖励值(优惠券名称/天数/积分数)
shippingNotesstringFalse发货说明
sortOrderinteger:int32False排序权重
specificationsstringFalse规格说明
stockinteger:int32False库存数量
totalExchangedinteger:int32False累计兑换数量

模型 MallProductVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<MallProductVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 MembershipPlanListVo

字段类型必填说明
itemsArray<MembershipPlanVo>False套餐列表
totalinteger:int32False总数

模型 MembershipPlanVo

字段类型必填说明
allBenefitsArray<string>False完整权益列表(自动生成 + 等级权益 + 套餐权益合并)
benefitsArray<string>False套餐自身权益列表(手动配置)
descriptionstringFalse套餐描述
durationDaysinteger:int32False有效天数
durationTypestringFalse时长类型
levelBenefitsArray<string>False等级权益列表(来自关联等级的配置)
levelColorstringFalse等级主题色
levelDisplayNamestringFalse会员等级显示名称
levelIconstringFalse等级图标
levelNamestringFalse会员等级名称(metadata.name)
levelPriorityinteger:int32False会员等级优先级
namestringFalse资源名称
originalPricenumberFalse原价
pricenumberFalse价格
recommendedbooleanFalse是否推荐
titlestringFalse套餐标题

模型 MembershipVo

字段类型必填说明
activebooleanFalse是否为会员
autoRenewbooleanFalse是否自动续费
benefitsArray<string>False权益列表(自动生成 + 等级配置的权益合并)
expireAtstring:date-timeFalse过期时间
levelColorstringFalse会员等级主题色
levelDisplayNamestringFalse会员等级显示名称
levelIconstringFalse会员等级图标
levelNamestringFalse会员等级名称(metadata.name)
levelPriorityinteger:int32False会员等级优先级
planNamestringFalse套餐名称
remainingDaysinteger:int32False剩余天数,-1表示永久
startAtstring:date-timeFalse开始时间

模型 Metadata

字段类型必填说明
annotationsobjectFalseAnnotations are like key-value format.
creationTimestampstring:date-timeFalseCreation timestamp of the Extension.
deletionTimestampstring:date-timeFalseDeletion timestamp of the Extension.
finalizersArray<string>False
generateNamestringFalseThe name field will be generated automatically according to the given generateName field
labelsobjectFalseLabels are like key-value format.
namestringTrueMetadata name
versioninteger:int64FalseCurrent version of the Extension. It will be bumped up every update.

模型 OrderVo

字段类型必填说明
amountnumberFalse订单金额
completedAtstring:date-timeFalse完成时间
createdAtstring:date-timeFalse创建时间
discountAmountnumberFalse优惠金额
namestringFalse资源名称
orderNostringFalse订单号
paidAmountnumberFalse实付金额
paidAtstring:date-timeFalse支付时间
paymentChannelstringFalse支付渠道
paymentNostringFalse支付流水号
phasestringFalse订单状态
productDisplayNamestringFalse商品展示名称
productIdstringFalse商品ID
productPermalinkstringFalse商品预览链接
productTitlestringFalse商品标题
productTypestringFalse商品类型
refundedAtstring:date-timeFalse退款时间
remarkstringFalse订单备注
usernamestringFalse用户名

模型 OrderVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<OrderVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 PasswordVerifyRequest

字段类型必填说明
passwordstringFalse
targetNamestringFalse
targetTypestringFalse

模型 PaymentInitVo

字段类型必填说明
amountnumberFalse支付金额
expireAtinteger:int64False过期时间戳
orderNostringFalse订单号
paymentChannelstringFalse支付渠道
paymentMethodstringFalse支付方式
paymentPageContentstringFalse支付页面内容(如支付宝表单 HTML)
paymentParamsobjectFalse支付参数(小程序/APP支付时使用)
paymentUrlstringFalse支付链接(H5/PC跳转支付时使用)
phasestringFalse订单阶段
qrCodestringFalse二维码内容(扫码支付时使用)

模型 PaymentMethodVo

字段类型必填说明
descriptionstringFalse支付方式说明
enabledbooleanFalse是否启用
iconstringFalse支付方式图标
idstringFalse支付方式 ID
namestringFalse支付方式名称
providerTypestringFalse提供方类型

模型 PaymentMethodVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<PaymentMethodVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 PaymentStatusVo

字段类型必填说明
gatewayStatusstringFalse网关状态
orderNostringFalse订单号
paidAtstringFalse支付时间
paymentChannelstringFalse支付渠道
paymentNostringFalse第三方支付流水号
phasestringFalse订单状态

模型 PaywallRelatedPostSummary

字段类型必填说明
coverstringFalse封面图
excerptstringFalse文章摘要
freePreviewbooleanFalse是否为免费试看文章
namestringFalse文章名称
permalinkstringFalse文章链接
publishTimestring:date-timeFalse发布时间
titlestringFalse文章标题

模型 PaywallTargetPreviewVo

字段类型必填说明
contextPaywallTargetSummaryFalse
relatedPostsArray<PaywallRelatedPostSummary>False用于预览的相关文章列表
targetPaywallTargetSummaryFalse

模型 PaywallTargetSummary

字段类型必填说明
allowChapterPurchasebooleanFalse是否允许单章购买
articleCountinteger:int32False文章数量
chapterPricenumberFalse单章价格
coverstringFalse封面图
descriptionstringFalse描述信息
displayNamestringFalse展示名称
labelstringFalse目标标签
namestringFalse目标名称
permalinkstringFalse跳转链接
typestringFalse目标类型

模型 PromotionCodeCheckVo

字段类型必填说明
distributorUsernamestringFalse
levelstringFalse
validbooleanFalse

模型 PublicCommentBadgeLevel

字段类型必填说明
anonymousEmailHashesArray<string>False
backgroundColorstringFalse
borderColorstringFalse
keystringFalse
labelstringFalse
textColorstringFalse

模型 PurchasedColumnListResponse

字段类型必填说明
itemsArray<PurchasedColumnVo>False
totalinteger:int32False

模型 PurchasedColumnVo

字段类型必填说明
articleCountinteger:int32False
authorUsernamestringFalse
authorsArray<AuthorDisplayVo>False
categoryNamestringFalse
completedCountinteger:int32False
coverstringFalse
descriptionstringFalse
displayNamestringFalse
lastReadAtstring:date-timeFalse
lastReadPostNamestringFalse
namestringFalse
originalPricenumberFalse
pricenumberFalse
progressPercentinteger:int32False
totalCountinteger:int32False

模型 QuestionCreateResultVo

字段类型必填说明
orderOrderVoFalse
questionQuestionVoFalse

模型 QuestionVo

字段类型必填说明
acceptedAtstring:date-timeFalse采纳时间
allowWatchbooleanFalse是否允许围观
answerstringFalse回答内容
answeredAtstring:date-timeFalse回答时间
answererstringFalse回答者用户名
answererRevenuenumberFalse回答者收入
askedAtstring:date-timeFalse提问时间
askerstringFalse提问者用户名
authorsArray<AuthorDisplayVo>False作者展示列表
contentstringFalse问题内容
hasAccessbooleanFalse当前用户是否有访问权限
namestringFalse资源名称
paidAtstring:date-timeFalse支付时间
phasestringFalse状态
platformRevenuenumberFalse平台收入
pricenumberFalse提问价格
titlestringFalse问题标题
totalRevenuenumberFalse总收入
watchCountinteger:int32False围观次数
watchPricenumberFalse围观价格

模型 QuestionVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<QuestionVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 RechargeRequest

字段类型必填说明
cardCodestringFalse

模型 ShippingAddress

字段类型必填说明
addressstringTrue详细地址
citystringTrue市
districtstringTrue区
phonestringTrue电话
provincestringTrue省
recipientNamestringTrue收件人

模型 ShippingAddressVo

字段类型必填说明
addressstringFalse详细地址
citystringFalse市
districtstringFalse区
phonestringFalse电话
provincestringFalse省
recipientNamestringFalse收件人

模型 SubmitRatingRequest

字段类型必填说明
commentstringFalse
contentNamestringFalse
contentTypestringFalse
ratinginteger:int32False

模型 TaskListVo

字段类型必填说明
tasksArray<TaskVo>False任务列表
totalinteger:int32False总数

模型 TaskVo

字段类型必填说明
claimedCountinteger:int32False领取人数
completedCountinteger:int32False完成人数
descriptionstringFalse任务描述
displayNamestringFalse任务显示名称
enabledbooleanFalse是否启用
expireAtstring:date-timeFalse过期时间
namestringFalse任务名称(唯一标识)
rewardDisplaystringFalse奖励显示文本
rewardTypestringFalse奖励类型
rewardValuestringFalse奖励值
sortOrderinteger:int32False排序顺序
startAtstring:date-timeFalse开始时间
targetCountinteger:int32False目标次数
targetNamestringFalse目标名称
targetProgressinteger:int32False用户目标进度
targetTypestringFalse目标类型
triggerTypestringFalse触发类型
typestringFalse任务类型
userProgressinteger:int32False用户当前进度
userStatusstringFalse用户任务状态

模型 TeamMemberListVo

字段类型必填说明
itemsArray<TeamMemberVo>False
totalinteger:int32False

模型 TeamMemberVo

字段类型必填说明
avatarstringFalse
bindAtstring:date-timeFalse
contributionnumberFalse
displayNamestringFalse
levelstringFalse
usernamestringFalse

模型 UcActivityGiftOverviewVo

字段类型必填说明
activitiesArray<ActivityGiftStatusVo>False
claimRecordsArray<GiftClaimRecord>False
pendingCountinteger:int64False

模型 UnlockMethodVo

字段类型必填说明
allowedLevelsArray<string>False允许的会员等级(membership 类型,空=所有会员)
originalPricenumberFalse原价(paid 类型)
pricenumberFalse价格(paid 类型)
requiredLevelstringFalse所需会员等级(level 类型)
scheduledAccessAtstring:date-timeFalse定时开放时间(scheduled 类型)
typestringFalse解锁方式类型
validDaysinteger:int32False有效天数,0=永久(paid 类型)

模型 UpdateProgressRequest

字段类型必填说明
postNamestringFalse

模型 UpdateQuestionRequest

字段类型必填说明
allowWatchbooleanFalse
contentstringFalse
pricenumberFalse
titlestringFalse
watchPricenumberFalse

模型 UpgradeInfoVo

字段类型必填说明
benefitsArray<string>False
canUpgradebooleanFalse
currentDisplayNamestringFalse
currentEditionstringFalse
targetDisplayNamestringFalse
targetEditionstringFalse
upgradeUrlstringFalse

模型 UserAccessVo

字段类型必填说明
acquireTypestringFalse获取方式
effectiveAtstring:date-timeFalse生效时间
expireAtstring:date-timeFalse失效时间
expiredbooleanFalse是否已过期
namestringFalse访问记录名称
orderCompletedAtstring:date-timeFalse订单完成时间
orderNostringFalse订单号
permalinkstringFalse预览链接
productNamestringFalse商品标识
productTitlestringFalse商品展示名称
productTypestringFalse商品类型
purchasedAtstring:date-timeFalse购买时间
usernamestringFalse用户名

模型 UserAccessVoList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<UserAccessVo>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 UserDripStatusVo

字段类型必填说明
chaptersArray<ChapterDripItem>False
nextUnlockTimestring:date-timeFalse
subscriptionAnchorstring:date-timeFalse
totalCountinteger:int32False
unlockedCountinteger:int32False

模型 UserProgressVo

字段类型必填说明
columnNamestringFalse
completedCountinteger:int32False
lastReadAtstring:date-timeFalse
lastReadPostNamestringFalse
progressPercentinteger:int32False
readPostNamesArray<string>False
totalCountinteger:int32False

模型 WalletTransaction

字段类型必填说明
apiVersionstringTrue
kindstringTrue
metadataMetadataTrue
specWalletTransactionSpecTrue

模型 WalletTransactionList

字段类型必填说明
firstbooleanTrueIndicates whether current page is the first page.
hasNextbooleanTrueIndicates whether current page has next page.
hasPreviousbooleanTrueIndicates whether current page has previous page.
itemsArray<WalletTransaction>TrueA chunk of items.
lastbooleanTrueIndicates whether current page is the last page.
pageinteger:int32TruePage number, starts from 1. If not set or equal to 0, it means no pagination.
sizeinteger:int32TrueSize of each page. If not set or equal to 0, it means no pagination.
totalinteger:int64TrueTotal elements.
totalPagesinteger:int64TrueIndicates total pages.

模型 WalletTransactionSpec

字段类型必填说明
amountnumberFalse交易金额(余额)
assetTypestringFalse资产类型
balanceAfternumberFalse交易后余额
balanceBeforenumberFalse交易前余额
cardNamestringFalse关联卡密名称
operationKeystringFalse业务幂等键
orderNamestringFalse关联订单名称
pointsinteger:int32False交易积分
pointsAfterinteger:int32False交易后积分
pointsBeforeinteger:int32False交易前积分
remarkstringFalse备注
reservedBalanceAfternumberFalse交易后冻结余额
reservedBalanceBeforenumberFalse交易前冻结余额
transactionAtstring:date-timeFalse交易时间
typestringFalse交易类型
usernamestringTrue用户名

模型 WithdrawApplyRequest

字段类型必填说明
accountInfostringFalse
amountnumberFalse
remarkstringFalse
withdrawMethodstringFalse

安全与状态处理

区分 401、403、404、409 和网关错误。若响应被重定向到登录页或返回 HTML,不能调用 json() 后当成业务成功。 页面按钮只控制展示,不能代替身份、所有者、金额、功能授权和支付回调验签。 评论凭证是 HttpOnly Cookie;仅输入邮箱的请求不能冒领。公开内容查询不能返回草稿/私密内容。

API 速览 · 支付配置