Transforme um programa de recompensas em um convite claro: uma taxa de ganho, uma escada de recompensas e um código QR fixo para adesão. Opcionalmente, mostre um total de pontos fornecido e recompensas disponíveis.
Cartão ao vivo
Categoria: Varejo. Tags: Restaurantes e cafés, Lojas, Códigos QR.
Layouts
Este cartão em tela cheia preenche toda a tela em paisagem ou retrato e não é colocado como canto, chip ou faixa.
Layouts: cheio. Formas: paisagem, retrato.
Layouts, temas e publicação de cartões. Veja os cartões.
Dados e privacidade
Este cartão usa suas propriedades configuradas e dados ao vivo do cartão.
Exibir somente totais de pontos aprovados para esta tela compartilhada.
Propriedades
Para tema, fundo, destaque e posição, veja Propriedades comuns.
Defina as propriedades estáticas nos params do cartão ao criá-lo. O documento de dados dele contém apenas propriedades dinâmicas. Linhas aninhadas descrevem o conteúdo da propriedade pai.
Propriedades estáticas
| Nome | Tipo | Padrão | Valores e limites | Descrição |
|---|---|---|---|---|
showProgress | boolean | false | ||
backgroundColor | string, nulo | null | padrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Substitui o fundo e a placa do cartão por uma cor plana ordenada por CSS. #RRGGBBAA fornece opacidade. background none tem precedência. |
textColor | string, nulo | null | padrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Substitui as cores do texto principal e secundário. As cores de destaque e status semântico mantêm seus papéis. |
Propriedades dinâmicas
| Nome | Tipo | Padrão | Valores e limites | Descrição |
|---|---|---|---|---|
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 | mínimo: 0; máximo: 1000000 | |
rewards | array | [] | maxItems: 6 | |
rewards[].points | integer | mínimo: 1; máximo: 1000000; Obrigatório | ||
rewards[].reward | string | minLength: 1; maxLength: 100; Obrigatório | ||
rewards[].detail | string | "" | maxLength: 160 |
Exemplo de tela
Salve as propriedades estáticas como params.json e crie o cartão. O resultado traz o id crd_ dele.
{
"theme": "neomustard"
}
screenrig card create --type loyalty --major 1 --file params.json
Adicione este item aos primitives de uma página da playlist, com esse id no lugar do id do exemplo. Publique a playlist e atribua uma tela.
{
"id": "loyalty",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Escrever dados ao vivo
Escreva o documento no cartão depois de criá-lo e depois substitua-o para atualizar a tela sem republicar. O cartão verifica cada gravação contra suas propriedades dinâmicas e recusa um documento que ele rejeita. Use o mesmo projeto da playlist.
Salve o documento como card-data.json. O CLI lê o documento em si, sem invólucro:
{
"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
Ou chame a API diretamente. A API envolve o mesmo documento em um campo document. Um token de agente já nomeia seu projeto, então nenhum cabeçalho de projeto é enviado; se você enviar ScreenRig-Project, ele deve corresponder ao projeto do token. Forneça sua autorização de API pelo ambiente; veja Autenticação da 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":[]}}'