GetQR API je v beta verzi a je dostupné pro vybrané pracovní prostory. Do obecného vydání se podrobnosti mohou změnit.
qrType a typ určuje, co musí obsahovat data. Tento návod uvádí formát každého typu, funkční tělo požadavku a co lze změnit, když už je kód vytištěný.
Příklady jsou těla požadavků pro vytvoření QR kódu. Posílejte je takto:
Přehled všech typů
Jak se QR kód vyhodnocuje
Každý QR kód tvoří krátký odkaz a datový obsah. Obsah nesou dvě pole:
Pravidla pro všechny typy:
- Výchozí hodnoty. Při vytváření převezme vynechané nebo prázdné
link.urlhodnotudataa celý objektlinkmůžete vynechat. Když pošlete obojí a hodnoty se liší, má přednostlink.url. Pošlete je stejné, nebo pošlete jendata. - Co obrázek kóduje. U všech typů kromě
wifikóduje obrázek krátký odkaz. Můžete tedy změnit, kam vytištěný kód vede, a jeho skenování se sledují. WiFi QR kód kóduje přímo síť: po vytištění ho nelze změnit a jeho skenování se nesledují. - Schémata.
link.urlpřijímá jenhttp:,https:,wifi:,mailto:,sms:abegin:. Cokoli jiného, včetněgeo:,smsto:,matmsg:atel:, vrátí422 Invalid destination URL, i když todatapřijme. - Prázdná data. Prázdné
datapřeskočí kontrolu typu. U přesměrovacího typu pak musí být nastavenélink.url, jinak volání vrátí400 Missing destination URL. - Struktura. Kromě kontroly typu server obsah neověřuje. U typu JSON stačí, aby šel naparsovat jako objekt JSON, a vCard musí jen začínat na
BEGIN:VCARD.
Website
qrType: "website". Návod pro dashboard: QR kód Website.
Request body
422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".422 Invalid destination URL
Feedback
qrType: "feedback". Návod pro dashboard: QR kód typu Feedback.
data je URL http(s) formuláře pro zpětnou vazbu, například Google Form nebo stránky s recenzemi. Vše ostatní funguje jako u typu Website.
Request body
Payment
qrType: "payment". Návod pro dashboard: QR kód typu Payment.
data je platební URL poskytovatele, například:
paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link a payoneer.com. U PayPal je částka posledním segmentem cesty. Funguje i jakákoli jiná URL http(s), ale editor ji nerozdělí na poskytovatele a částku. Vše ostatní funguje jako u typu Website.
Request body
qrType: "whatsapp". Návod pro dashboard: QR kód WhatsApp.
data je odkaz wa.me: mezinárodní číslo jen v číslicích bez +, volitelně s předvyplněným textem.
api.whatsapp.com/send. Vše ostatní funguje jako u typu Website.
Request body
Location
qrType: "location". Návod pro dashboard: QR kód typu Location.
data je URL mapy. Aby QR kód zůstal v dashboardu upravitelný, použijte tento formát (query_place_id je nepovinný):
geo: projde kontrolou data, ale jako cíl se odmítne, proto ho nepoužívejte. Vše ostatní funguje jako u typu Website.
Request body
App Link
qrType: "app". Návod pro dashboard: QR kód typu App Link.
Request body
422 Invalid URL400 Missing destination URL
qrType: "email". Návod pro dashboard: QR kód typu Email.
Request body
422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".
SMS
qrType: "sms". Návod pro dashboard: QR kód typu SMS.
Request body
422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".
WiFi
qrType: "wifi". Návod pro dashboard: QR kód WiFi.
Request body
422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
PDF, Image a Video
qrType: "pdf", "image" nebo "video". Návody pro dashboard: PDF, Image, Video.
Jeden soubor na QR kód: balíčky PDF a galerie obrázků přes API k dispozici nejsou. Viz Nepodporováno přes API.
fileId, najdete v části Soubory.
vCard
qrType: "vcard". Návod pro dashboard: QR kód typu vCard.
Vstupní stránka a editor čtou jen řádky v níže uvedených tvarech. Jiné varianty, například
TEL;CELL: nebo EMAIL;TYPE=INTERNET:, se uloží, ale na stránce se nezobrazí.
N:<last>;<first>;;;: příjmení a jméno. Editor: obojí povinné, nejvýše 40 znaků.FN:<first> <last>: stránka ho nečte. Podle něj se tvoří popisek v seznamu v dashboardu.ORG:<company>aTITLE:<role>: společnost a pozice. Editor: nejvýše 40 znaků.TEL;TYPE=HOME:,TEL;TYPE=CELL:,TEL;TYPE=WORK:,TEL;TYPE=FAX:: telefon, mobil, pracovní telefon a fax (+a číslice).EMAIL:<email>: e-mailová adresa.URL:<url>: web.NOTE:<text>: shrnutí. Escapujte\\,\n,\;a\,. Editor: nejvýše 200 znaků.ADR:;;<street>;<city>;<state>;<zip>;<country>: adresa.X-SOCIALPROFILE;TYPE=<platform>:<url>neboURL;TYPE=<PLATFORM>:<url>: odkazy na sociální sítě, jeden řádek na platformu.PHOTO;VALUE=URI:<url>: URL profilového obrázku. Má přednost před jakýmkoli ID souboru.X-GETQR-IMAGE-FILEID:<fileId>: profilový obrázek (cíllogo).X-GETQR-PAGE-LOGO-FILEID:<fileId>: logo stránky (cíllogo).X-GETQR-LANDING-THEME:p|<0-4>neboX-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: motiv vstupní stránky, buď index předvolby (0 až 4), nebo vlastní barvy pozadí, tlačítek a ikon.
facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".
Social Media
qrType: "social". Návod pro dashboard: QR kód Social Media.
Pole v
data:
Request body
422 Expected a JSON object describing the social profile page for qrType "social".
Multi-Link
qrType: "multilink". Návod pro dashboard: QR kód typu Multi-Link.
Pole v
data jsou stejná jako u typu Social Media, jen firstName, lastName a summary nahrazují tato pole:
V
customItems je logoFileId nepovinné: zobrazí se záložní ikona. Editor: alespoň jeden odkaz na sociální síť nebo jedna neprázdná vlastní položka.
Request body
422 Expected a JSON object describing the multi-link page for qrType "multilink".
Event
qrType: "event". Návod pro dashboard: QR kód typu Event.
Pole v
data:
Typy akcí
Typy akcí
conference, seminar, workshop, training, webinar, meetup, networking, corporateEvent, productLaunch, tradeShow, jobFair, fundraiser, charity, wedding, engagement, birthday, anniversary, babyShower, graduation, reunion, party, religious, funeralMemorial, ceremony, concert, festival, clubNight, theater, comedy, filmScreening, exhibition, sports, tournament, raceMarathon, fitnessClass, foodDrink, market, openHouse, community, schoolEvent, kids, travelTourVybavení
Vybavení
Request body
422 Expected a JSON object describing the event page for qrType "event".
Soubory v QR kódech
Zaregistrujte soubor přes Soubory, nahrajte ho a pak předejte jehofileId. Použijte cíl, který odpovídá účelu:
pdf,image,video. Obsah QR kódu typu PDF, Image nebo Video.logo. Profilové obrázky, loga stránek, ikony vlastních odkazů a loga uprostřed kódu.
fileId, které se vracejí při vytváření a při PATCH, pokud pošlete fileId:
ID souborů uvnitř obsahu (
fileId, pageLogoFileId, customItems[].logoFileId, řádky X-GETQR-*-FILEID) se neověřují. Zobrazí se, jen pokud byly nahrány s cílem logo. QR kód si je přivlastní, takže je úklid nechá být.
Změna typu
qrType můžete změnit pomocí úpravy QR kódu. Pošlete data, která odpovídají novému typu: uložený obsah patří starému typu, takže změna bez nich se odmítne.
Po úpravě se cíl určuje v tomto pořadí:
vcard,social,multilink,event: vždy hostovaná stránka.- Balíček PDF nebo galerie obrázků vytvořená v dashboardu: její vstupní stránka.
pdf,image,video: URL souboru (novéfileId, jinak uložené).link.url, pokud je posláno.- Změněná
data. - Uložená URL.
- Z
pdf,imagenebovideo.fileIdi případný balíček nebo galerie se vymažou. - Na
pdf,imagenebovideo. Pošlete ifileId, jinak se znovu použije uložené, což může být fotka vCard. - Z
app. Název aplikace,link.iosalink.androidse vymažou, takže telefony půjdou na nový cíl. - Na
wifi. Obrázek přejde na surový obsah. Už vytištěné kódy dál obsahují krátký odkaz, který teď přesměruje na URLwifi:. - Z
wifi. Vytištěné kódy si ponechají starou síť. - Na
vcard,social,multilinkneboevent. Krátký odkaz se přesměruje na novou hostovanou stránku. - Z
vcard,social,multilinkneboevent. Pošlete novádata. Cíl se řídí jimi.
link.url vrátí 422.
Nepodporováno přes API
Tyto funkce dashboardu nejsou součástí API v1. Neznámá pole se bez chyby zahodí, takže jejich odeslání nemá žádný účinek.
Balíčky a galerie vytvořené v dashboardu lze přes API dál číst, pozastavovat a mazat, ale jejich soubory přes něj měnit nelze.
Časté problémy
422 Invalid destination URL
422 Invalid destination URL
link.url používá schéma, na které krátký odkaz nemůže přesměrovat, například geo:, smsto:, matmsg: nebo tel:. Použijte formáty z této stránky.400 Missing destination URL
400 Missing destination URL
data je prázdné a chybí link.url. U app nastavte alespoň jedno z link.ios, link.android, link.url nebo data.V odpovědi je v data krátký odkaz, ne moje URL
V odpovědi je v data krátký odkaz, ne moje URL
U typů s odkazem je v uloženém
data krátký odkaz. Cíl čtěte z url.Na vstupní stránce chybí údaje z mého obsahu
Na vstupní stránce chybí údaje z mého obsahu
Stránka čte jen pole a tvary řádků uvedené u daného typu. Ostatní pole se uloží, ale nezobrazí.