Ein scharfer Code für einen Link, Wi-Fi, einen Kontakt, ein Ereignis oder einen App-Store sitzt auf hellem Papier mit dunklen, scharfen Modulen, sodass er aus der Entfernung sauber gescannt werden kann. Er füllt den Bildschirm, sitzt in der Mitte, schmiegt sich in eine Ecke, läuft als eine Linie in einer Ecke oder erstreckt sich als Band entlang einer Kante. Sie legen fest, was der Code trägt, fügen eine Beschriftung und eine kleinere Zeile darunter hinzu, wählen die Tinten- und Papierfarben sowie die Modul- und Finder-Augen-Formen und fügen ein Logo in kleiner oder großer Größe oder ein Symbol mit einem gerahmten Call-to-Action hinzu.
Live-Karte
Kategorie: Nachrichten. Schlagwörter: QR-Codes, Geschäfte, Restaurants und Cafés, Wartebereiche und Empfang.
Layouts
Diese Kernkarte passt in jedes Layout: Vollbild, Mitte, breit, Ecke, Chip, Streifen oder jedes freie Rechteck.
Layouts: voll, Mitte, breit, Ecke, Chip, Streifen. Formulare: Querformat, Hochformat, Quadrat, Streifen.
Kartenlayouts, Designs und Veröffentlichung. Karten durchsuchen.
Daten und Datenschutz
Diese Karte verwendet ihre konfigurierten Eigenschaften und Live-Kartendaten.
Eigenschaften
Für Thema, Hintergrund, Akzent und Position siehe Gemeinsame Eigenschaften.
Legen Sie statische Eigenschaften in den params der Karte fest, wenn Sie sie erstellen. Ihr Datendokument enthält nur dynamische Eigenschaften. Verschachtelte Zeilen beschreiben den Inhalt ihrer übergeordneten Eigenschaft.
Statische Eigenschaften
| Name | Typ | Standard | Werte und Grenzwerte | Beschreibung |
|---|---|---|---|---|
ecc | string | "M" | "L", "M", "Q", "H" | |
ink | string | "#111111" | Muster: "^#[0-9A-Fa-f]{6}$" | Modulfarbe. Dunkel auf hellem Papier halten. |
paper | string | "#FFFFFF" | Muster: "^#[0-9A-Fa-f]{6}$" | Kartenfarbe hinter dem Code. |
style | object | additionalProperties: false | Modul- und Sucher-Augenformen; jede standardmäßig vom Thema. | |
style.modules | string | "square", "rounded", "dots", "connected" | ||
style.eyes | string | "square", "rounded", "circle", "leaf" | ||
logo | Null, Zeichenkette | 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" | Ein Symbol, zentriert auf einem Papier-Knockout-Pad; null für keines. Erhöht ECC auf Q (H bei groß). |
logoScale | string | "small" | "small", "large" | |
frame | string | "none" | "none", "card", "ticket", "badge" | Ein Rahmen mit dem Aufruf zum Handeln. |
textless | boolean | false | Nur Code: keine Beschriftung, Details, Labels oder Handlungsaufforderungen in jeder Ansicht. | |
backgroundColor | String, Null | null | Muster: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Überschreibt den Kartenhintergrund und die Platte mit einer flachen, CSS-geordneten Farbe. #RRGGBBAA gibt die Deckkraft an. Hintergrund none hat Vorrang. |
textColor | String, Null | null | Muster: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Überschreibt die Haupt- und Sekundärtextfarben. Akzent- und semantische Statusfarben behalten ihre Funktion. |
Dynamische Eigenschaften
| Name | Typ | Standard | Werte und Grenzwerte | Beschreibung |
|---|---|---|---|---|
value | string | "" | maxLength: 1024 | Eine rohe Nutzlast. Wenn gesetzt, hat sie Vorrang vor action. |
action | object | additionalProperties: false | Erstellt die Nutzlast, wenn value leer ist. Felder nach Typ: 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"; erforderlich | ||
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 | Minimum: -90; Maximum: 90 | ||
action.longitude | number | Minimum: -180; Maximum: 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 | Kleine Linie unter der Beschriftung; leer zeigt den Wert an, wenn es sich um eine URL handelt. |
cta | string | "" | maxLength: 40 | Call to action; ein Rahmen ohne sagt „Scannen Sie mich“. |
Canvas-Beispiel
Speichern Sie die statischen Eigenschaften als params.json und erstellen Sie die Karte. Das Ergebnis enthält ihre crd_ ID.
{
"theme": "neomustard"
}
screenrig card create --type qr-code --major 1 --file params.json
Fügen Sie diesen Eintrag den primitives einer Playlist-Seite hinzu, mit dieser ID anstelle der Beispiel-ID. Veröffentlichen Sie die Playlist und weisen Sie einen Bildschirm zu.
{
"id": "qr-code",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Live-Daten schreiben
Schreiben Sie das Dokument nach dem Erstellen in die Karte und ersetzen Sie es dann, um den Bildschirm ohne erneute Veröffentlichung zu aktualisieren. Die Karte prüft jeden Schreibvorgang gegen ihre dynamischen Eigenschaften und lehnt ein Dokument ab, das sie nicht akzeptiert. Verwenden Sie dasselbe Projekt wie die Playlist.
Speichern Sie das Dokument als card-data.json. Die CLI liest das Dokument selbst, ohne Wrapper:
{
"value": "",
"action": {
"type": "url"
},
"caption": "",
"detail": "",
"cta": ""
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
Oder rufen Sie die API direkt auf. Die API verpackt dasselbe Dokument in ein document-Feld. Ein Agent-Token benennt bereits sein Projekt, daher wird kein Projekt-Header gesendet; wenn Sie ScreenRig-Project senden, muss es zum Token-Projekt passen. Stellen Sie Ihre API-Autorisierung über die Umgebung bereit; siehe API-Authentifizierung.
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":""}}'