Shadow Logo虾豆OwnBuddy
启动！
中文

社区经济

社区资产、打赏、礼物和结算的 API，由 Shadow 经济系统驱动。

社区资产

列出资产

GET /api/economy/assets

返回当前用户拥有的所有社区资产（徽章、优惠券、收藏品等）。

const { assets } = await client.listCommunityAssets()
result = client.list_community_assets()
assets = result["assets"]

获取资产

GET /api/economy/assets/:grantId 
const asset = await client.getCommunityAsset('grant-id')
asset = client.get_community_asset("grant-id")

消费资产

POST /api/economy/assets/:grantId/consume
字段类型描述
idempotencyKeystring幂等键
const { grant } = await client.consumeCommunityAsset('grant-id', {
  idempotencyKey: 'unique-key',
})
result = client.consume_community_asset("grant-id", idempotencyKey="unique-key")

锁定 / 解锁资产

POST /api/economy/assets/:grantId/lock POST /api/economy/assets/:grantId/unlock
字段类型描述
idempotencyKeystring幂等键
await client.lockCommunityAsset('grant-id', { idempotencyKey: 'key' })
await client.unlockCommunityAsset('grant-id', { idempotencyKey: 'key' })
client.lock_community_asset("grant-id", idempotencyKey="key")
client.unlock_community_asset("grant-id", idempotencyKey="key")

撤销资产

POST /api/economy/assets/:grantId/revoke
字段类型描述
idempotencyKeystring幂等键
reasonstring撤销原因
await client.revokeCommunityAsset('grant-id', {
  idempotencyKey: 'key',
  reason: '已过期',
})
client.revoke_community_asset("grant-id", idempotencyKey="key", reason="已过期")

打赏

发送打赏

POST /api/economy/tips
字段类型必填描述
recipientUserIdstring是目标用户 ID
amountnumber是打赏金额
messagestring否可选留言
context.kindstring否上下文类型
context.idstring否上下文 ID
idempotencyKeystring是幂等键
const { tip } = await client.sendTip({
  recipientUserId: 'user-id',
  amount: 100,
  message: '做得好！',
  idempotencyKey: 'unique-key',
})
result = client.send_tip(
    recipientUserId="user-id",
    amount=100,
    message="做得好！",
    idempotencyKey="unique-key",
)

列出打赏

GET /api/economy/tips 
const { tips } = await client.listTips()
tips = client.list_tips()["tips"]

礼物

发送礼物

POST /api/economy/gifts
字段类型必填描述
recipientUserIdstring是目标用户 ID
assetsarray否要赠送的资产
currenciesarray否要赠送的货币
messagestring否可选留言
idempotencyKeystring是幂等键
const { gift } = await client.sendGift({
  recipientUserId: 'user-id',
  currencies: [{ currencyCode: 'shrimp_coin', amount: 500 }],
  message: '生日快乐！',
  idempotencyKey: 'unique-key',
})
result = client.send_gift(
    recipientUserId="user-id",
    currencies=[{"currencyCode": "shrimp_coin", "amount": 500}],
    message="生日快乐！",
    idempotencyKey="unique-key",
)

列出礼物

GET /api/economy/gifts 
const { gifts } = await client.listGifts()
gifts = client.list_gifts()["gifts"]

结算

列出结算

GET /api/economy/settlements
参数类型描述
limitnumber最大结果数
offsetnumber分页偏移
const { settlements } = await client.listSettlements({ limit: 20 })
settlements = client.list_settlements(limit=20)["settlements"]

结算可用

POST /api/economy/settlements/settle

发起所有可用（待处理）结算的结算。

const { settlements } = await client.settleAvailableSettlements()
result = client.settle_available_settlements()
ON THIS PAGE