适用于数字标牌屏幕的忠诚度卡片

将奖励计划转化为清晰的邀请：赚取率、奖励阶梯和固定的加入二维码。可选显示提供的积分总数和可用奖励。

直播卡片

此卡由浏览器绘制，使用与播放器相同的代码，带示例数据。

类别：零售。标签：餐厅和咖啡馆，商店，二维码。

布局

此全屏卡在横屏或竖屏时填满整个屏幕，不作为角落、芯片或条带放置。

布局：全屏。表单：横向，纵向。

卡片布局、主题和发布。浏览卡片。

数据与隐私

此卡使用其配置的属性和实时卡数据。

仅显示此共享屏幕批准的积分总数。

属性

有关主题、背景、强调色和位置，请参见通用属性。

创建卡片时，在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。

静态属性

名称	类型	默认	数值和限制	描述
`showProgress`	boolean	`false`
`backgroundColor`	字符串，空值	`null`	模式：`"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	用纯色 CSS 顺序覆盖卡片背景和底板。#RRGGBBAA 提供透明度。背景无则优先。
`textColor`	字符串，空值	`null`	模式：`"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称	类型	默认	数值和限制
`title`	string	`"Good things add up"`	maxLength：`80`
`earnRate`	string	`""`	maxLength：`160`
`description`	string	`""`	maxLength：`360`
`joinUrl`	string	`""`	maxLength：`2048`
`qrLabel`	string	`"Join the rewards"`	maxLength：`80`
`footnote`	string	`""`	maxLength：`240`
`updatedAt`	string	`""`	maxLength：`40`
`points`	integer	`0`	最小值：`0`；最大值：`1000000`
`rewards`	array	`[]`	maxItems：`6`
`rewards[].points`	integer		最小值：`1`；最大值：`1000000`；必填
`rewards[].reward`	string		minLength：`1`；maxLength：`100`；必填
`rewards[].detail`	string	`""`	maxLength：`160`

画布示例

将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。

{
  "theme": "neomustard"
}

screenrig card create --type loyalty --major 1 --file params.json

将此项目添加到播放列表页面的primitives中，并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。

{
  "id": "loyalty",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

创建卡片后向其写入文档，之后替换该文档即可更新屏幕，无需重新发布。卡片会按其动态属性检查每次写入，并拒绝它不接受的文档。请使用与播放列表相同的项目。

将文档保存为card-data.json。CLI直接读取文档，无需包装：

{
  "title": "Good things add up",
  "earnRate": "",
  "description": "",
  "joinUrl": "",
  "qrLabel": "Join the rewards",
  "footnote": "",
  "updatedAt": "",
  "points": 0,
  "rewards": []
}

screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

或直接调用 API。API 将相同文档包装在 document 字段中。智能体令牌已指定其项目，因此不发送项目头；若发送 ScreenRig-Project，必须与令牌项目匹配。通过环境提供 API 授权；详见 API 认证。

curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"title":"Good things add up","earnRate":"","description":"","joinUrl":"","qrLabel":"Join the rewards","footnote":"","updatedAt":"","points":0,"rewards":[]}}'