Přizpůsobení

GetQR API je v beta verzi a je dostupné pro vybrané pracovní prostory. Do obecného vydání se podrobnosti mohou změnit.

Vzhled QR kódu nastavíte pomocí volitelných objektů styles, frameOptions a logoOptions při jeho vytvoření nebo úpravě. Všechna pole jsou volitelná a pro vše, co vynecháte, platí výchozí hodnoty. Stejné tři objekty fungují u QR kódů, šablon i hromadného vytváření. Neznámé tvary, rámečky nebo loga se odmítnou s 422.

Příklad objektu designu

{
  "styles": {
    "dotsOptions": { "type": "rounded", "color": "#000000" },
    "backgroundOptions": { "color": "#ffffff" },
    "cornersSquareOptions": { "type": "dot", "color": "#000000" },
    "cornersDotOptions": { "type": "dot", "color": "#000000" }
  },
  "frameOptions": { "id": "card", "text": "Scan me!", "color": "#000000", "textColor": "#ffffff" },
  "logoOptions": { "type": "suggested", "id": "logo-google", "scalePercent": 25 }
}

Pošlete ho spolu se zbytkem QR kódu:

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "styles": { "dotsOptions": { "type": "rounded", "color": "#1E40AF" } },
    "frameOptions": { "id": "card", "text": "Scan me!" },
    "logoOptions": { "type": "suggested", "id": "logo-website-3" }
  }'

Styly

Objekt styles nastavuje tvary a barvy vzoru.

Pole	Hodnoty
`dotsOptions.type`	Tvar bodů těla: `square`, `dots`, `rounded`, `classy`, `classy-rounded`, `extra-rounded`
`cornersSquareOptions.type`	Tvar rohového čtverce (rámeček oka): `square`, `rounded`, `dot`, `classy-rounded`
`cornersDotOptions.type`	Tvar rohového bodu (zornice oka): `square`, `dot`, `dots`, `rounded`, `classy`
`dotsOptions.color`	Barva popředí. Výchozí `#000000`.
`backgroundOptions.color`	Barva pozadí. Výchozí `#ffffff`.
`cornersSquareOptions.color`, `cornersDotOptions.color`	Přijmou se, ale nemají žádný účinek: rohy vždy používají `dotsOptions.color`.

Barvy. Jen hex hodnoty: #RGB nebo #RRGGBB.
Korekce chyb. Vždy Q a nedá se nastavit. Odeslání styles.qrOptions vrátí 422.
Designy Branded a AI. Přes API je nastavit nelze. Odeslání styles.logoQrArt vrátí 422.
Obsah. styles.data se ignoruje. Obrázek vždy kóduje obsah QR kódu.

Mezi barvou popředí a pozadí udržujte dostatečný kontrast, s tmavým popředím na světlém pozadí. Kódy s nízkým kontrastem nemusí jít naskenovat. Viz Barvy.

Rámečky

Objekt frameOptions přidá kolem QR kódu dekorativní rámeček s výzvou k akci.

Pole	Popis
`id`	Povinné, když posíláte `frameOptions`. Typ rámečku ze seznamů níže. `none` znamená bez rámečku.
`text`	Popisek výzvy k akci, nejvýše 12 znaků. Výchozí `Scan me!`.
`color`	Barva rámečku, hex.
`textColor`	Barva popisku, hex. Pokud rámeček zobrazuje popisek, musí se lišit od `color`, ledaže jde o jednu z vestavěných barevných předvoleb rámečku.
`borderColor`	Barva okraje, hex.
`fingerPrintColor`	Barva zvýraznění ikony rámečku, hex.

Obecné rámečky

none, card, card-1, card-2, card-3, card-4, card-5, card-7, card-8, card-9, card-10, card-11, card-12, card-13, card-14, card-15, card-hor, wreath, envelope, waitress, coffee-cup, scooter, clipboardcard-hor nezobrazuje žádný popisek.

Rámečky podle typu QR kódu

Typ	Rámečky s popiskem	Rámečky bez popisku
App Link	`app-3`	`app-1`, `app-2`
vCard	`contact-1`, `contact-5`	`contact-2`, `contact-3`, `contact-4`
Email	`email-1`	`email-2`, `email-3`, `email-4`, `email-5`
Feedback	—	`feedback-1`, `feedback-2`, `feedback-3`, `feedback-4`, `feedback-5`
Image	—	`image-1`, `image-2`, `image-3`, `image-4`, `image-5`, `image-6`
Location	`location-3`	`location-1`, `location-2`, `location-4`, `location-5`, `location-6`
Multi-Link	`multilink-3`	`multilink-1`, `multilink-2`
Payment	—	`payment-1`, `payment-2`, `payment-3`, `payment-4`, `payment-5`
PDF	`pdf-1`	`pdf-2`, `pdf-3`, `pdf-4`
SMS	`sms-3`, `sms-5`, `sms-7`	`sms-1`, `sms-2`, `sms-4`, `sms-6`
Social Media	`social-3`	`social-1`, `social-2`, `social-4`
Video	`video-1`, `video-3`	`video-2`, `video-4`, `video-5`, `video-6`
Website	`website-1`	`website-2`, `website-3`, `website-4`, `website-5`
WhatsApp	`whatsapp-2`	`whatsapp-1`, `whatsapp-3`, `whatsapp-4`
WiFi	—	`wifi-1`, `wifi-2`, `wifi-3`, `wifi-4`

Každý rámeček funguje s každým typem QR kódu. Seskupení odpovídá dashboardu.

Rámečky bez popisku nemají v dashboardu pole pro výzvu k akci a pravidlo, že se textColor musí lišit od color, se na ně nevztahuje.

Loga

Objekt logoOptions umístí logo doprostřed QR kódu. Druh loga zvolíte pomocí type.

Navrhované logo

Nastavte type na suggested a vyberte id z katalogu. Pro žádné logo použijte logo-none.

{ "logoOptions": { "type": "suggested", "id": "logo-instagram", "scalePercent": 25 } }

Všechna ID navrhovaných log

logo-none, logo-website-3, logo-website-4, logo-link, logo-pdf-1, logo-pdf-2, logo-pdf-3, logo-picture-1, logo-picture-2, logo-picture-3, logo-picture-5, logo-picture-7, logo-picture-8, logo-video-1, logo-video-5, logo-whatsapp-1, logo-whatsapp-2, logo-whatsapp, logo-wifi-1, logo-wifi-2, logo-wifi-3, logo-wifi, logo-airbnb, logo-apple, logo-binance, logo-bitcoin, logo-bolt-food, logo-booking, logo-facebook, logo-glovo, logo-google, logo-google-maps, logo-google-play, logo-instagram, logo-linkedin, logo-location, logo-mail, logo-paypal, logo-stripe, logo-venmo, logo-cashapp, logo-braintree, logo-square, logo-verifone, logo-google-pay, logo-apple-pay, logo-klarna, logo-ayden, logo-giropay, logo-cartes-bancaires, logo-restaurant, logo-scan-me, logo-tripadvisor, logo-trustpilot, logo-uber-eats, logo-youtube, logo-spotify, logo-spotify-black

Vlastní logo

Nahrajte obrázek

Zaregistrujte ho přes Soubory s "target": "logo" a pak soubor nahrajte na vrácenou uploadUrl.

Odkažte na soubor

Nastavte type na uploaded a fileId na vrácené fileId. fileId je povinné a musí to být ID, které vrátil endpoint Soubory.

{ "logoOptions": { "type": "uploaded", "fileId": "file_7bQ2xR9mKp", "scalePercent": 35 } }

Neznámý soubor, nedokončené nahrání nebo soubor nahraný pro jiný cíl se odmítne.

Velikost loga

scalePercent nastavuje velikost loga jako procento QR kódu. Přijímá celé číslo od 15 do 45. Výchozí hodnota je 25. Jiné hodnoty, včetně poměrů jako 0.25, vrátí 422.

Úprava designu

Částečné úpravy. Při úpravě QR kódu se styles, frameOptions a logoOptions sloučí s uloženým designem. Částečný objekt změní jen to, co uvádí.
Změna loga. Výběr jiného loga nahradí uložené logo, ale zachová jeho scalePercent.
Šablony. S templateId při vytváření se pole, která pošlete, sloučí s designem šablony a mají přednost. Viz Šablony.
Designy Branded a AI. QR kód s designKind branded nebo ai byl vytvořen v dashboardu. API nemůže upravit jeho obrázek, ale při změně ostatních polí ho zachová.
Čtení designu. Odpovědi vracejí uložený design pod design ve stejném tvaru jako pole požadavku, takže ho můžete poslat zpět.

Časté problémy

422 "Error correction is always Q and is not an input"

Odeberte z požadavku styles.qrOptions.

422 "Frame caption is at most 12 characters"

Zkraťte frameOptions.text na nejvýše 12 znaků.

422 "Frame caption color must differ from the frame color"

textColor a color jsou stejné u rámečku, který zobrazuje popisek. Zvolte kontrastní textColor.

422 "Logo scale is a whole number from 15 to 45"

Pošlete scalePercent jako celé procento, například 25, ne 0.25.

Barva rohů se nemění

Rohy vždy používají dotsOptions.color. cornersSquareOptions.color a cornersDotOptions.color nemají žádný účinek.

API

Příklad objektu designu

Styly

Rámečky

Loga

Navrhované logo

Vlastní logo

Velikost loga

Úprava designu

Časté problémy

Co dál

QR kódy

Šablony

Soubory

Přehled designu

​Příklad objektu designu

​Styly

​Rámečky

​Loga

​Navrhované logo

​Vlastní logo

​Velikost loga

​Úprava designu

​Časté problémy

​Co dál

QR kódy

Šablony

Soubory

Přehled designu

Příklad objektu designu

Styly

Rámečky

Loga

Navrhované logo

Vlastní logo

Velikost loga

Úprava designu

Časté problémy

Co dál