Ugrás a fő tartalomhoz
A GetQR API béta állapotban van, és csak kiválasztott munkaterületek számára érhető el. A részletek az általános kiadásig változhatnak.
Minden QR-kódnak van egy qrType értéke, és a típus határozza meg, mit kell tartalmaznia a data mezőnek. Ez az útmutató minden típushoz megadja a formátumot, egy működő kéréstörzset, és azt, hogy mit módosíthat még a kód kinyomtatása után. A példák a QR-kód létrehozása végpont kéréstörzsei. Így küldje el őket:

Minden típus egy pillantásra

Hogyan vezet célhoz a QR-kód

Minden QR-kód egy rövid linkből és egy tartalomból áll. A tartalmat két mező hordozza: Szabályok minden típusra:
  • Alapértékek. Létrehozáskor a hiányzó vagy üres link.url a data értékét kapja, és a teljes link objektumot elhagyhatja. Ha mindkettőt elküldi, és eltérnek, a link.url az erősebb. Küldje őket azonos értékkel, vagy csak a data mezőt küldje.
  • Mit kódol a kép. A kép a wifi kivételével minden típusnál a rövid linket kódolja. Így módosíthatja, hová vezet egy kinyomtatott kód, és a beolvasásai is követhetők. A WiFi QR-kód magát a hálózatot kódolja: nyomtatás után nem módosítható, és a beolvasásai nem követhetők.
  • Sémák. A link.url csak a http:, https:, wifi:, mailto:, sms: és begin: sémát fogadja el. Minden más, köztük a geo:, smsto:, matmsg: és tel:, 422 Invalid destination URL hibát kap, akkor is, ha a data elfogadja.
  • Üres data. Üres data esetén a típusellenőrzés kimarad. Átirányító típusnál ilyenkor a link.url mezőt meg kell adni, különben a hívás 400 Missing destination URL hibát kap.
  • Felépítés. A típusellenőrzésen túl a szerver nem validálja a tartalmat. Egy JSON-típusnak csak JSON-objektumként kell értelmezhetőnek lennie, a vCardnak pedig csak BEGIN:VCARD sorral kell kezdődnie.
Az alább Készítő jelöléssel ellátott korlátokat az irányítópult szerkesztője érvényesíti. Az API az ezeket figyelmen kívül hagyó tartalmat is elfogadja, de az furcsán jelenhet meg a landing oldalon vagy a szerkesztőben.

Website

qrType: "website". Irányítópult-útmutató: Website QR-kód.
Request body
Hibák:
  • 422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".
  • 422 Invalid destination URL

Visszajelzés

qrType: "feedback". Irányítópult-útmutató: Visszajelzés QR-kód. A data a visszajelzési űrlap http(s) URL-je, például egy Google Form vagy egy értékelési oldal. Minden más úgy működik, mint a Website típusnál.
Request body

Fizetés

qrType: "payment". Irányítópult-útmutató: Fizetési QR-kód. A data a szolgáltató fizetési URL-je, például:
Az irányítópult szerkesztője ezeket a hosztokat ismeri fel: paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link és payoneer.com. PayPal esetén az összeg az útvonal utolsó szakasza. Bármely más http(s) URL is működik, de a szerkesztő nem bontja szolgáltatóra és összegre. Minden más úgy működik, mint a Website típusnál.
Request body

WhatsApp

qrType: "whatsapp". Irányítópult-útmutató: WhatsApp QR-kód. A data egy wa.me link: a nemzetközi telefonszám számjegyei + nélkül, opcionálisan előre kitöltött szöveggel.
A szerver csak azt ellenőrzi, hogy http(s) URL-ről van-e szó. Az irányítópult az api.whatsapp.com/send linkeket is beolvassa. Minden más úgy működik, mint a Website típusnál.
Request body

Helyszín

qrType: "location". Irányítópult-útmutató: Helyszín QR-kód. A data egy térkép-URL. Használja ezt a formátumot, hogy a QR-kód az irányítópulton szerkeszthető maradjon (a query_place_id opcionális):
Bármely más http(s) URL is átirányít. Egy geo: URI átmegy a data ellenőrzésén, de célként a rendszer elutasítja, ezért ne használja. Minden más úgy működik, mint a Website típusnál.
Request body
qrType: "app". Irányítópult-útmutató: App Link QR-kód.
Request body
Hibák:
  • 422 Invalid URL
  • 400 Missing destination URL

E-mail

qrType: "email". Irányítópult-útmutató: E-mail QR-kód.
Request body
Hibák:
  • 422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".

SMS

qrType: "sms". Irányítópult-útmutató: SMS QR-kód.
Request body
Hibák:
  • 422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".

WiFi

qrType: "wifi". Irányítópult-útmutató: WiFi QR-kód.
Request body
Hibák:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
Kinyomtatott WiFi QR-kód típusát ne változtassa meg. A kinyomtatott kódok a régi hálózatot tartják meg.

PDF, kép és videó

qrType: "pdf", "image" vagy "video". Irányítópult-útmutatók: PDF, Image, Video. QR-kódonként egy fájl: a PDF-csomagok és képgalériák az API-ban nem érhetők el. Lásd: Az API-n keresztül nem támogatott.
A fájl feltöltéséről és a fileId megszerzéséről lásd: Fájlok.

vCard

qrType: "vcard". Irányítópult-útmutató: vCard QR-kód. A landing oldal és a szerkesztő csak az alábbi sorformákat olvassa. Más változatokat, például a TEL;CELL: vagy az EMAIL;TYPE=INTERNET: formát, a rendszer tárolja, de nem jelennek meg az oldalon.
  • N:<last>;<first>;;;: vezeték- és keresztnév. Készítő: mindkettő kötelező, legfeljebb 40 karakter.
  • FN:<first> <last>: az oldal nem olvassa. Az irányítópult listájának címkéje ebből származik.
  • ORG:<company> és TITLE:<role>: cég és beosztás. Készítő: legfeljebb 40 karakter.
  • TEL;TYPE=HOME:, TEL;TYPE=CELL:, TEL;TYPE=WORK:, TEL;TYPE=FAX:: telefon-, mobil-, munkahelyi és faxszám (+ és számjegyek).
  • EMAIL:<email>: e-mail-cím.
  • URL:<url>: weboldal.
  • NOTE:<text>: összefoglaló. Escapelje a \\, \n, \; és \, karaktereket. Készítő: legfeljebb 200 karakter.
  • ADR:;;<street>;<city>;<state>;<zip>;<country>: cím.
  • X-SOCIALPROFILE;TYPE=<platform>:<url> vagy URL;TYPE=<PLATFORM>:<url>: közösségi linkek, platformonként egy sor.
  • PHOTO;VALUE=URI:<url>: a profilkép URL-je. Erősebb bármely fájlazonosítónál.
  • X-GETQR-IMAGE-FILEID:<fileId>: profilkép (logo cél).
  • X-GETQR-PAGE-LOGO-FILEID:<fileId>: oldallogó (logo cél).
  • X-GETQR-LANDING-THEME:p|<0-4> vagy X-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: a landing oldal témája, vagy egy előbeállítás indexe (0–4), vagy egyéni háttér-, gomb- és ikonszínek.
Közösségi platformok: facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
Hibák:
  • 422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".

Social Media

qrType: "social". Irányítópult-útmutató: Social Media QR-kód. A data mezői:
Request body
Hibák:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
qrType: "multilink". Irányítópult-útmutató: Multi-Link QR-kód. A data mezői megegyeznek a Social Media típuséval, azzal a különbséggel, hogy a firstName, lastName és summary helyett ezek szerepelnek: A customItems elemeiben a logoFileId opcionális: hiánya esetén egy tartalék ikon jelenik meg. Készítő: legalább egy közösségi link vagy egy nem üres egyéni elem.
Request body
Hibák:
  • 422 Expected a JSON object describing the multi-link page for qrType "multilink".

Event

qrType: "event". Irányítópult-útmutató: Event QR-kód. A data mezői:
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, travelTour
Request body
Hibák:
  • 422 Expected a JSON object describing the event page for qrType "event".

Fájlok a QR-kódokban

Regisztrálja a fájlt a Fájlok végponttal, töltse fel, majd adja át a fileId értékét. A felhasználásnak megfelelő célt válassza:
  • pdf, image, video. Egy PDF, Image vagy Video QR-kód tartalma.
  • logo. Profilképek, oldallogók, egyéni linkek ikonjai és középső logók.
Azokat a fájlokat, amelyek soha nem kapcsolódnak QR-kódhoz, a rendszer egy türelmi idő után törli. fileId hibák, amelyeket létrehozáskor, illetve PATCH esetén kaphat, ha elküldi a fileId mezőt: A tartalmon belüli fájlazonosítókat (fileId, pageLogoFileId, customItems[].logoFileId, X-GETQR-*-FILEID sorok) a rendszer nem validálja. Csak akkor jelennek meg, ha logo céllal töltötték fel őket. A QR-kód magáénak tekinti őket, így a takarítás nem törli őket.

Típusváltás

A qrType értékét a QR-kód frissítése végponttal módosíthatja. Az új típusnak megfelelő data értéket küldjön: a tárolt tartalom a régi típushoz tartozik, ezért a nélküle végzett váltást a rendszer elutasítja. Frissítés után a cél ebben a sorrendben dől el:
  1. vcard, social, multilink, event: mindig a hosztolt oldal.
  2. Az irányítópulton készült PDF-csomag vagy képgaléria: annak landing oldala.
  3. pdf, image, video: a fájl URL-je (az új fileId, különben a tárolt).
  4. A link.url, ha elküldi.
  5. A módosított data.
  6. A tárolt URL.
Mit eredményez az egyes váltások:
  • pdf, image vagy video típusról. A fileId és az esetleges csomag vagy galéria törlődik.
  • pdf, image vagy video típusra. Küldje el a fileId mezőt is, különben a tárolt érték kerül újra felhasználásra, ami akár egy vCard-fotó is lehet.
  • app típusról. Az alkalmazás neve, a link.ios és a link.android törlődik, így a telefonok az új célra jutnak.
  • wifi típusra. A kép a nyers tartalomra vált. A már kinyomtatott kódok továbbra is a rövid linket tartalmazzák, amely mostantól egy wifi: URL-re irányít át.
  • wifi típusról. A kinyomtatott kódok a régi hálózatot tartják meg.
  • vcard, social, multilink vagy event típusra. A rövid link az új hosztolt oldalra mutat.
  • vcard, social, multilink vagy event típusról. Küldje el az új data értéket. A cél ezt követi.
Az irányítópulton készült statikus QR-kódoknak nincs rövid linkjük, ezért a link.url módosítása 422 hibát ad.

Az API-n keresztül nem támogatott

Ezek az irányítópult-funkciók nem részei a v1 API-nak. Az ismeretlen mezőket a rendszer hiba nélkül elveti, így elküldésüknek nincs hatása. Az irányítópulton készült csomagok és galériák az API-n keresztül is lekérhetők, szüneteltethetők és törölhetők, de a fájljaik nem módosíthatók rajta keresztül.

Gyakori problémák

A link.url olyan sémát használ, amelyre a rövid link nem tud átirányítani, például geo:, smsto:, matmsg: vagy tel:. Használja az ezen az oldalon leírt formátumokat.
A data üres, és nincs link.url. Az app típusnál adja meg legalább a link.ios, link.android, link.url vagy data egyikét.
Az oldal csak az adott típusnál felsorolt mezőket és sorformákat olvassa. A többi mezőt a rendszer tárolja, de nem jeleníti meg.

Következő lépések

QR-kódok

Fájlok

Testreszabás

Hozzáférési szabályok