Finder API 与数据字段
核对基线:main 6df20471d848;重新生成不会导出插件实现。
同步对象直接读取;Mono 用 .block() 并判空;Flux 用 .collectList().block()。分页 Mono 结果读取 items。
Base 的 Pro 兼容方法可能返回空/false/零值对象;方法存在不代表业务已启用。公开专栏/章节遵守服务端可见性过滤。
方法合同
| 方法 | 返回类型 | 参数 |
getPluginInfo | PluginInfoVo | `` |
checkAccess | Mono<AccessCheckVo> | String targetType, String targetName |
getMembershipStatus | Mono<MembershipVo> | `` |
listMembershipPlans | Flux<MembershipPlanVo> | `` |
listAvailableCoupons | Flux<CouponVo> | String productType, BigDecimal amount |
getMyWallet | Mono<UserWallet> | `` |
listMyOrders | Mono<ListResult<OrderVo>> | Integer page, Integer size |
listMyCoupons | Flux<CouponVo> | String status |
listMyPurchases | Mono<ListResult<UserAccessVo>> | Integer page, Integer size |
getAvailableTasks | Flux<TaskFinderVo> | `` |
getTask | Mono<TaskFinderVo> | String taskName |
getMyTasks | Flux<UserTaskFinderVo> | `` |
listColumns | Flux<ColumnVo> | Integer page, Integer size |
getColumnDetail | Mono<ColumnDetailVo> | String columnName |
getColumnByCategory | Mono<ColumnVo> | String categoryName |
getUserProgress | Mono<UserProgressVo> | String columnName |
listChaptersByTag | Flux<ChapterVo> | String columnName, String tagName |
listPurchasedColumns | Flux<ColumnVo> | `` |
getDripStatus | Mono<UserDripStatusVo> | String columnName |
getDistributorProfile | Mono<DistributorVo> | `` |
getDistributorStatistics | Mono<DistributionStatisticsVo> | `` |
getPromotionUrl | Mono<String> | String productType, String productId |
getPromotionQrCode | Mono<String> | String productType, String productId |
isDistributor | Mono<Boolean> | `` |
getDistributionSettings | Mono<DistributionSettingsVo> | `` |
getRecentCommissions | Flux<DistributionVo> | int limit |
getTeamMembers | Flux<TeamMemberVo> | int limit |
getRatingStatistics | Mono<RatingStatisticsVo> | String contentType, String contentName |
getTopRatedContent | Flux<RatingStatisticsVo> | int limit |
getCommentRewardStatistics | Mono<RewardStatisticsVo> | String commentName |
batchGetCommentRewardStatistics | Flux<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
| 字段 | 类型 | 说明 |
grantedBy | string | 授权方式类型(granted 时有值,标识哪种解锁方式放行) |
hasAccess | boolean | 是否有访问权限 |
previewLength | integer:int32 | 试看字数 |
previewRatio | integer:int32 | 试看比例 0-100 |
purchaseTargetName | string | 下单/购买应使用的目标名称 |
purchaseTargetType | string | 下单/购买应使用的目标类型 |
resolvedTargetName | string | 命中的规则目标名称 |
resolvedTargetType | string | 命中的规则目标类型 |
unlockMethods | Array<UnlockMethodVo> | 可用的解锁方式列表(拒绝时返回) |
MembershipPlanVo
| 字段 | 类型 | 说明 |
allBenefits | Array<string> | 完整权益列表(自动生成 + 等级权益 + 套餐权益合并) |
benefits | Array<string> | 套餐自身权益列表(手动配置) |
description | string | 套餐描述 |
durationDays | integer:int32 | 有效天数 |
durationType | string | 时长类型 |
levelBenefits | Array<string> | 等级权益列表(来自关联等级的配置) |
levelColor | string | 等级主题色 |
levelDisplayName | string | 会员等级显示名称 |
levelIcon | string | 等级图标 |
levelName | string | 会员等级名称(metadata.name) |
levelPriority | integer:int32 | 会员等级优先级 |
name | string | 资源名称 |
originalPrice | number | 原价 |
price | number | 价格 |
recommended | boolean | 是否推荐 |
title | string | 套餐标题 |
MembershipVo
| 字段 | 类型 | 说明 |
active | boolean | 是否为会员 |
autoRenew | boolean | 是否自动续费 |
benefits | Array<string> | 权益列表(自动生成 + 等级配置的权益合并) |
expireAt | string:date-time | 过期时间 |
levelColor | string | 会员等级主题色 |
levelDisplayName | string | 会员等级显示名称 |
levelIcon | string | 会员等级图标 |
levelName | string | 会员等级名称(metadata.name) |
levelPriority | integer:int32 | 会员等级优先级 |
planName | string | 套餐名称 |
remainingDays | integer:int32 | 剩余天数,-1表示永久 |
startAt | string:date-time | 开始时间 |
OrderVo
| 字段 | 类型 | 说明 |
amount | number | 订单金额 |
completedAt | string:date-time | 完成时间 |
createdAt | string:date-time | 创建时间 |
discountAmount | number | 优惠金额 |
name | string | 资源名称 |
orderNo | string | 订单号 |
paidAmount | number | 实付金额 |
paidAt | string:date-time | 支付时间 |
paymentChannel | string | 支付渠道 |
paymentNo | string | 支付流水号 |
phase | string | 订单状态 |
productDisplayName | string | 商品展示名称 |
productId | string | 商品ID |
productPermalink | string | 商品预览链接 |
productTitle | string | 商品标题 |
productType | string | 商品类型 |
refundedAt | string:date-time | 退款时间 |
remark | string | 订单备注 |
username | string | 用户名 |
UserAccessVo
| 字段 | 类型 | 说明 |
acquireType | string | 获取方式 |
effectiveAt | string:date-time | 生效时间 |
expireAt | string:date-time | 失效时间 |
expired | boolean | 是否已过期 |
name | string | 访问记录名称 |
orderCompletedAt | string:date-time | 订单完成时间 |
orderNo | string | 订单号 |
permalink | string | 预览链接 |
productName | string | 商品标识 |
productTitle | string | 商品展示名称 |
productType | string | 商品类型 |
purchasedAt | string:date-time | 购买时间 |
username | string | 用户名 |
UserWallet
| 字段 | 类型 | 说明 |
apiVersion | string | |
kind | string | |
metadata | Metadata | |
spec | UserWalletSpec | |
ColumnVo
| 字段 | 类型 | 说明 |
allowChapterPurchase | boolean | |
articleCount | integer:int32 | |
authorUsername | string | |
authors | Array<AuthorDisplayVo> | |
categoryDisplayName | string | |
categoryName | string | |
chapterPrice | number | |
cover | string | |
description | string | |
displayName | string | |
dripEnabled | boolean | |
enabled | boolean | |
name | string | |
originalPrice | number | |
phase | string | |
price | number | |
sortOrder | integer:int32 | |
subscriberCount | integer:int32 | |
totalViews | integer:int64 | |
ChapterVo
| 字段 | 类型 | 说明 |
authorUsername | string | |
dripStatus | string | |
isFreePreview | boolean | |
isPendingUnlock | boolean | |
isRead | boolean | |
name | string | |
permalink | string | |
priority | integer:int32 | |
publishTime | string:date-time | |
published | boolean | |
slug | string | |
tags | Array<string> | |
title | string | |
unlockTime | string:date-time | |
DistributorVo
| 字段 | 类型 | 说明 |
applyReason | string | |
approvedAt | string:date-time | |
avatar | string | |
contactInfo | string | |
createdAt | string:date-time | |
directCount | integer:int32 | |
displayName | string | |
level | string | |
name | string | |
orderCount | integer:int32 | |
parentUsername | string | |
pendingCommission | number | |
phase | string | |
promotionCode | string | |
realName | string | |
rejectReason | string | |
teamCount | integer:int32 | |
totalCommission | number | |
username | string | |
withdrawnAmount | number | |
DistributionStatisticsVo
| 字段 | 类型 | 说明 |
directCount | integer:int32 | |
monthCommission | number | |
orderCount | integer:int32 | |
pendingCommission | number | |
teamCount | integer:int32 | |
todayCommission | number | |
todayNewCount | integer:int32 | |
totalCommission | number | |
withdrawnAmount | number | |
API 速览 · 组件参考