𝐗𝐀𝐈 𝐗𝐀𝐏𝐈

X-CARD 动态卡片服务

产品简介

X-CARD 是面向运营与前端团队的动态卡片分发服务。通过一个统一的 API，您可以实时创建、排序、下线和统计公告卡片，无需改动前端代码即可在应用内分发运营信息。

快速体验

  1. 前往 https://card.xabcstack.com 获取展示示例，使用 sk- 前缀的 XAPI 私有密钥调用管理接口。
  2. 调用 POST /x-card 创建卡片，设置标题、内容、跳转链接和生效天数。
  3. 在前端使用 GET /x-card/{pk-...} 读取卡片列表（公钥可直接嵌入前端）。
  4. 通过 PUT /x-card/{id} 更新文案或优先级，或用 DELETE /x-card/{id} 即时下线。

核心能力

  • 统一内容投放：通过优先级和有效期控制卡片展示顺序与上下线节奏。
  • 免部署更新：所有文案与图片均经 API 托管，适合快速运营迭代。
  • 多渠道兼容：同一公钥可被 Web、移动端、桌面端安全读取。
  • 事件通知：卡片创建、更新、删除会触发事件总线，方便联动数据面板。

API 参考

方法路径说明
POST/x-card创建卡片（需要 sk- 私钥）
GET/x-card管理员查看当前账户的卡片（需私钥，可加 all=true 查看历史）
GET/x-card/{pk-...}通过公钥读取公开卡片列表，可选 limit 参数
PUT/POST/x-card/{id}更新卡片内容或优先级
DELETE/x-card/{id}删除卡片

公钥读取接口无需鉴权，便于前端直接嵌入；私钥接口返回完整管理数据。

示例：创建公告卡片

export XAPI_KEY="你的XAPI-KEY" # sk- 开头的密钥

curl -X POST https://api.xabcstack.com/x-card \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $XAPI_KEY" \
  -d '{
      "title": "系统维护通知",
      "content": "9 月 1 日 02:00-04:00 进行系统升级，请提前保存数据。",
      "link": "https://status.yoursite.com",
      "priority": 10,
      "days": 3
    }'

常见问题

  • 是否支持图片？ 可在创建时传入 image_url 字段，将在前端原样展示。
  • 如何限制展示次数？ 创建时指定 max_views，超出后自动隐藏。
  • 能否批量管理？ GET /x-card?all=true 返回所有卡片，结合事件总线可同步到自建后台。