Finder API 与数据字段

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

同步对象直接读取;Mono 用 .block() 并判空;Flux 用 .collectList().block()。分页 Mono 结果读取 items。

Base 的 Pro 兼容方法可能返回空/false/零值对象;方法存在不代表业务已启用。公开专栏/章节遵守服务端可见性过滤。

方法合同

方法返回类型参数
getPluginInfoPluginInfoVo``
checkAccessMono<AccessCheckVo>String targetType, String targetName
getMembershipStatusMono<MembershipVo>``
listMembershipPlansFlux<MembershipPlanVo>``
listAvailableCouponsFlux<CouponVo>String productType, BigDecimal amount
getMyWalletMono<UserWallet>``
listMyOrdersMono<ListResult<OrderVo>>Integer page, Integer size
listMyCouponsFlux<CouponVo>String status
listMyPurchasesMono<ListResult<UserAccessVo>>Integer page, Integer size
getAvailableTasksFlux<TaskFinderVo>``
getTaskMono<TaskFinderVo>String taskName
getMyTasksFlux<UserTaskFinderVo>``
listColumnsFlux<ColumnVo>Integer page, Integer size
getColumnDetailMono<ColumnDetailVo>String columnName
getColumnByCategoryMono<ColumnVo>String categoryName
getUserProgressMono<UserProgressVo>String columnName
listChaptersByTagFlux<ChapterVo>String columnName, String tagName
listPurchasedColumnsFlux<ColumnVo>``
getDripStatusMono<UserDripStatusVo>String columnName
getDistributorProfileMono<DistributorVo>``
getDistributorStatisticsMono<DistributionStatisticsVo>``
getPromotionUrlMono<String>String productType, String productId
getPromotionQrCodeMono<String>String productType, String productId
isDistributorMono<Boolean>``
getDistributionSettingsMono<DistributionSettingsVo>``
getRecentCommissionsFlux<DistributionVo>int limit
getTeamMembersFlux<TeamMemberVo>int limit
getRatingStatisticsMono<RatingStatisticsVo>String contentType, String contentName
getTopRatedContentFlux<RatingStatisticsVo>int limit
getCommentRewardStatisticsMono<RewardStatisticsVo>String commentName
batchGetCommentRewardStatisticsFlux<RewardStatisticsVo>List<String> commentNames

关键字段

  • PluginInfoVo:edition、pro、pluginName、version、cssUrl、jsUrl、assetsBaseUrl。资源通常已经自动注入。
  • MembershipPlanVo 的标题为 title;MembershipVo 的有效标记为 active、到期时间 expireAt。
  • ColumnDetailVo:column、chapters、userProgress;ChapterVo 使用 permalink,没有 locked 字段。
  • AccessCheckVo 的 purchaseTargetType/purchaseTargetName 是集合规则下的下单目标。

数据模型字段

以下字段摘自当前 OpenAPI。未列出的 Finder 专用类型以对应安装版本为准,不猜测字段。

AccessCheckVo

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

MembershipPlanVo

字段类型说明
allBenefitsArray<string>完整权益列表(自动生成 + 等级权益 + 套餐权益合并)
benefitsArray<string>套餐自身权益列表(手动配置)
descriptionstring套餐描述
durationDaysinteger:int32有效天数
durationTypestring时长类型
levelBenefitsArray<string>等级权益列表(来自关联等级的配置)
levelColorstring等级主题色
levelDisplayNamestring会员等级显示名称
levelIconstring等级图标
levelNamestring会员等级名称(metadata.name)
levelPriorityinteger:int32会员等级优先级
namestring资源名称
originalPricenumber原价
pricenumber价格
recommendedboolean是否推荐
titlestring套餐标题

MembershipVo

字段类型说明
activeboolean是否为会员
autoRenewboolean是否自动续费
benefitsArray<string>权益列表(自动生成 + 等级配置的权益合并)
expireAtstring:date-time过期时间
levelColorstring会员等级主题色
levelDisplayNamestring会员等级显示名称
levelIconstring会员等级图标
levelNamestring会员等级名称(metadata.name)
levelPriorityinteger:int32会员等级优先级
planNamestring套餐名称
remainingDaysinteger:int32剩余天数,-1表示永久
startAtstring:date-time开始时间

OrderVo

字段类型说明
amountnumber订单金额
completedAtstring:date-time完成时间
createdAtstring:date-time创建时间
discountAmountnumber优惠金额
namestring资源名称
orderNostring订单号
paidAmountnumber实付金额
paidAtstring:date-time支付时间
paymentChannelstring支付渠道
paymentNostring支付流水号
phasestring订单状态
productDisplayNamestring商品展示名称
productIdstring商品ID
productPermalinkstring商品预览链接
productTitlestring商品标题
productTypestring商品类型
refundedAtstring:date-time退款时间
remarkstring订单备注
usernamestring用户名

UserAccessVo

字段类型说明
acquireTypestring获取方式
effectiveAtstring:date-time生效时间
expireAtstring:date-time失效时间
expiredboolean是否已过期
namestring访问记录名称
orderCompletedAtstring:date-time订单完成时间
orderNostring订单号
permalinkstring预览链接
productNamestring商品标识
productTitlestring商品展示名称
productTypestring商品类型
purchasedAtstring:date-time购买时间
usernamestring用户名

UserWallet

字段类型说明
apiVersionstring
kindstring
metadataMetadata
specUserWalletSpec

ColumnVo

字段类型说明
allowChapterPurchaseboolean
articleCountinteger:int32
authorUsernamestring
authorsArray<AuthorDisplayVo>
categoryDisplayNamestring
categoryNamestring
chapterPricenumber
coverstring
descriptionstring
displayNamestring
dripEnabledboolean
enabledboolean
namestring
originalPricenumber
phasestring
pricenumber
sortOrderinteger:int32
subscriberCountinteger:int32
totalViewsinteger:int64

ChapterVo

字段类型说明
authorUsernamestring
dripStatusstring
isFreePreviewboolean
isPendingUnlockboolean
isReadboolean
namestring
permalinkstring
priorityinteger:int32
publishTimestring:date-time
publishedboolean
slugstring
tagsArray<string>
titlestring
unlockTimestring:date-time

DistributorVo

字段类型说明
applyReasonstring
approvedAtstring:date-time
avatarstring
contactInfostring
createdAtstring:date-time
directCountinteger:int32
displayNamestring
levelstring
namestring
orderCountinteger:int32
parentUsernamestring
pendingCommissionnumber
phasestring
promotionCodestring
realNamestring
rejectReasonstring
teamCountinteger:int32
totalCommissionnumber
usernamestring
withdrawnAmountnumber

DistributionStatisticsVo

字段类型说明
directCountinteger:int32
monthCommissionnumber
orderCountinteger:int32
pendingCommissionnumber
teamCountinteger:int32
todayCommissionnumber
todayNewCountinteger:int32
totalCommissionnumber
withdrawnAmountnumber

API 速览 · 组件参考