Um código nítido para um link, Wi-Fi, um contato, um evento ou uma loja de aplicativos fica em papel claro com módulos escuros e nítidos, para que escaneie limpo de longe. Ele preenche a tela, fica no meio, se encaixa em um canto, corre como uma linha em um canto ou se estende como uma faixa ao longo de uma borda. Você define o que o código carrega, adiciona uma legenda e uma linha menor abaixo, escolhe as cores da tinta e do papel e as formas do módulo e do olho localizador, e adiciona um logo em tamanho pequeno ou grande ou um ícone, com um chamado à ação emoldurado.
Cartão ao vivo
Categoria: Mensagens. Etiquetas: Códigos QR, Lojas, Restaurantes e cafés, Saguões e recepção.
Layouts
Este cartão principal se encaixa em qualquer layout: tela cheia, centro, largo, canto, chip, faixa ou qualquer retângulo livre.
Layouts: cheio, centro, largo, canto, chip, faixa. Formas: paisagem, retrato, quadrado, faixa.
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.
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 |
|---|---|---|---|---|
ecc | string | "M" | "L", "M", "Q", "H" | |
ink | string | "#111111" | padrão: "^#[0-9A-Fa-f]{6}$" | Cor do módulo. Mantenha escuro sobre papel claro. |
paper | string | "#FFFFFF" | padrão: "^#[0-9A-Fa-f]{6}$" | Cor do cartão atrás do código. |
style | object | additionalProperties: false | Formas do módulo e do olho localizador; cada um usa o padrão do tema. | |
style.modules | string | "square", "rounded", "dots", "connected" | ||
style.eyes | string | "square", "rounded", "circle", "leaf" | ||
logo | nulo, string | null | null, "activity-01", "air-vent", "airplane-01", "alert-01", "alert-02", "american-football", "analytics-up", "apple", "arrow-down-01", "arrow-down-right-01", "arrow-up-01", "arrow-up-right-01", "award-01", "baseball", "basketball-01", "battery-full", "bell-ring", "bicycle", "birthday-cake", "bitcoin", "bus-01", "calendar-03", "calendar-04", "calendar-add-01", "calendar-check", "call-02", "camera-01", "cancel-circle", "car-01", "champion", "chart-decrease", "chart-increase", "checkmark-circle-02", "clock-01", "clock-02", "cloud", "cloud-angled-rain", "cloud-angled-zap", "cloud-big-rain", "cloud-drizzle", "cloud-fog", "cloud-hailstone", "cloud-snow", "coffee-01", "coffee-02", "contact-01", "container-truck-01", "cricket-bat", "crown", "delivery-truck-01", "dices", "discord", "discount-tag-01", "dollar-02", "door-closed-locked", "door-open", "drink", "droplet", "ethereum", "euro", "exchange-01", "facebook-01", "factory", "fast-wind", "favourite", "ferry-boat", "fire", "fire-02", "first-aid-kit", "flag-01", "flag-02", "flash", "flower-01", "football", "gauge", "gift", "git-branch", "globe-02", "google", "hand-prayer", "heart", "help-circle", "home-01", "hourglass", "humidity", "ice-hockey", "information-circle", "instagram", "lamp-01", "lantern", "leaf-01", "leaf-02", "lightbulb", "link-01", "linkedin-01", "litecoin", "location-01", "location-04", "mail-01", "medal-first-place", "medical-mask", "meeting-room", "megaphone-01", "message-01", "money-exchange-02", "moon-02", "moon-cloud", "moon-star", "music-note-01", "navigation-03", "new-releases", "new-twitter", "news", "news-01", "noodles", "package-delivered", "parking-area-square", "party", "party-popper", "pause-circle", "percent-circle", "pinterest", "pizza-01", "play-circle", "play-store", "podium", "pound", "pumpkin", "qr-code", "qr-code-01", "queue-01", "quote-down", "quote-up", "ranking", "restaurant-01", "rocket-01", "rss", "running-shoes", "sale-tag-01", "security-check", "shop-sign", "shopping-bag-01", "siren", "smart-phone-01", "snapchat", "snowflake", "sparkles", "spotify", "star", "star-half", "star-off", "stop-circle", "store-01", "sun-03", "sun-cloud-02", "sunrise", "sunset", "swimming", "tag-01", "target-02", "temperature", "tennis-ball", "thermometer", "thermometer-cold", "thermometer-warm", "threads", "ticket-01", "tiktok", "time-quarter-pass", "timer-01", "tornado-02", "train-01", "tram", "trophy", "tropical-storm", "tsunami", "user-02", "user-group", "user-love-01", "vegetarian-food", "volleyball", "volume-high", "vote", "walking", "warehouse", "waves", "whatsapp", "wheat-off", "wifi-01", "wifi-full-signal", "wifi-lock", "wrench-01", "yen", "youtube" | Um ícone centralizado em um suporte de papel recortado; null para nenhum. Eleva ECC para Q (H quando grande). |
logoScale | string | "small" | "small", "large" | |
frame | string | "none" | "none", "card", "ticket", "badge" | Um quadro contendo o chamado para ação. |
textless | boolean | false | Apenas código: sem legenda, detalhe, rótulo ou chamada para ação, em todas as visualizações. | |
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 |
|---|---|---|---|---|
value | string | "" | maxLength: 1024 | Um payload bruto. Quando definido, tem prioridade sobre action. |
action | object | additionalProperties: false | Constrói o payload quando value está vazio. Campos por tipo: url {url, utm}; phone {number}; sms {number, message}; email {to, subject, body}; wifi {ssid, password, security, hidden}; vcard {first, last, org, title, phone, email, url, address}; event {title, start, end, location, description}; geo {latitude, longitude, label}; whatsapp {number, message}; social {network, handle}; review {placeId}; app {ios, android}; text {text}. | |
action.type | string | "url", "phone", "sms", "email", "wifi", "vcard", "event", "geo", "whatsapp", "social", "review", "app", "text"; Obrigatório | ||
action.url | string | maxLength: 1024 | ||
action.utm | object | additionalProperties: false | ||
action.utm.source | string | maxLength: 100 | ||
action.utm.medium | string | maxLength: 100 | ||
action.utm.campaign | string | maxLength: 100 | ||
action.utm.content | string | maxLength: 100 | ||
action.utm.term | string | maxLength: 100 | ||
action.number | string | maxLength: 40 | ||
action.message | string | maxLength: 300 | ||
action.to | string | maxLength: 200 | ||
action.subject | string | maxLength: 200 | ||
action.body | string | maxLength: 600 | ||
action.ssid | string | maxLength: 64 | ||
action.password | string | maxLength: 64 | ||
action.security | string | "WPA", "WEP", "nopass" | ||
action.hidden | boolean | |||
action.first | string | maxLength: 80 | ||
action.last | string | maxLength: 80 | ||
action.org | string | maxLength: 120 | ||
action.title | string | maxLength: 120 | ||
action.phone | string | maxLength: 40 | ||
action.email | string | maxLength: 200 | ||
action.address | string | maxLength: 300 | ||
action.start | string | maxLength: 40 | ||
action.end | string | maxLength: 40 | ||
action.location | string | maxLength: 200 | ||
action.description | string | maxLength: 600 | ||
action.latitude | number | mínimo: -90; máximo: 90 | ||
action.longitude | number | mínimo: -180; máximo: 180 | ||
action.label | string | maxLength: 120 | ||
action.network | string | "instagram", "facebook", "x", "linkedin", "tiktok", "youtube", "threads" | ||
action.handle | string | maxLength: 80 | ||
action.placeId | string | maxLength: 200 | ||
action.ios | string | maxLength: 1024 | ||
action.android | string | maxLength: 1024 | ||
action.text | string | maxLength: 1024 | ||
caption | string | "" | maxLength: 80 | |
detail | string | "" | maxLength: 120 | Linha pequena sob a legenda; vazio mostra o valor quando é uma URL. |
cta | string | "" | maxLength: 40 | Chamada para ação; um quadro sem nenhuma exibe "Escaneie-me". |
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 qr-code --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": "qr-code",
"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:
{
"value": "",
"action": {
"type": "url"
},
"caption": "",
"detail": "",
"cta": ""
}
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":{"value":"","action":{"type":"url"},"caption":"","detail":"","cta":""}}'