Pāriet uz galveno saturu
GetQR API ir beta versijā un pieejams atlasītām darbvietām. Līdz vispārējai izlaišanai detaļas var mainīties.
Katram QR kodam ir qrType, un veids nosaka, kas jāsatur laukam data. Šajā ceļvedī katram veidam ir norādīts formāts, strādājošs pieprasījuma pamatteksts un tas, ko vēl varat mainīt pēc koda izdrukāšanas. Piemēri ir pieprasījuma pamatteksti galapunktam QR koda izveide. Sūtiet tos šādi:

Visi veidi īsumā

Kā QR kods novirza uz mērķi

Katrs QR kods ir īsā saite un saturs. Saturu nes divi lauki: Noteikumi visiem veidiem:
  • Noklusējumi. Izveidojot QR kodu, izlaists vai tukšs link.url kļūst par data, un visu objektu link varat neiekļaut. Ja nosūtīti abi un tie atšķiras, priekšroka ir link.url. Sūtiet tos vienādus vai sūtiet tikai data.
  • Ko kodē attēls. Attēls kodē īso saiti visiem veidiem, izņemot wifi. Tāpēc varat mainīt, kurp ved izdrukāts kods, un tā skenējumi tiek izsekoti. WiFi QR kods kodē pašu tīklu: pēc izdrukāšanas to nevar mainīt, un tā skenējumi netiek izsekoti.
  • Shēmas. link.url pieņem tikai http:, https:, wifi:, mailto:, sms: un begin:. Jebkas cits, ieskaitot geo:, smsto:, matmsg: un tel:, saņem 422 Invalid destination URL, pat ja data to pieņem.
  • Tukši dati. Tukšs data izlaiž veida pārbaudi. Novirzīšanas veidam tad jābūt iestatītam link.url, citādi izsaukums saņem 400 Missing destination URL.
  • Struktūra. Papildus veida pārbaudei serveris saturu nevalidē. JSON veidam saturam jābūt tikai parsējamam kā JSON objektam, un vCard saturam jāsākas ar BEGIN:VCARD.
Tālāk ar Veidotājs atzīmētie ierobežojumi ir tie, ko piemēro informācijas paneļa redaktors. API pieņem saturu, kas tos neievēro, bet tas var neparasti attēloties galamērķa lapā vai redaktorā.

Website

qrType: "website". Ceļvedis informācijas panelim: Website QR kods.
Request body
Kļūdas:
  • 422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".
  • 422 Invalid destination URL

Atsauksmes

qrType: "feedback". Ceļvedis informācijas panelim: Atsauksmju QR kods. data ir atsauksmju veidlapas http(s) URL, piemēram, Google Form vai atsauksmju lapa. Viss pārējais darbojas tāpat kā veidam Website.
Request body

Maksājums

qrType: "payment". Ceļvedis informācijas panelim: Maksājuma QR kods. data ir pakalpojuma sniedzēja maksājuma URL, piemēram:
Informācijas paneļa redaktors atpazīst šos resursdatorus: paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link un payoneer.com. PayPal gadījumā summa ir ceļa pēdējais segments. Der arī jebkurš cits http(s) URL, taču redaktors to nesadalīs pakalpojuma sniedzējā un summā. Viss pārējais darbojas tāpat kā veidam Website.
Request body

WhatsApp

qrType: "whatsapp". Ceļvedis informācijas panelim: WhatsApp QR kods. data ir wa.me saite: starptautisks numurs cipariem bez +, pēc izvēles ar iepriekš aizpildītu tekstu.
Serveris pārbauda tikai to, vai tas ir http(s) URL. Informācijas panelis nolasa arī api.whatsapp.com/send saites. Viss pārējais darbojas tāpat kā veidam Website.
Request body

Atrašanās vieta

qrType: "location". Ceļvedis informācijas panelim: Atrašanās vietas QR kods. data ir kartes URL. Izmantojiet šo formātu, lai QR kods paliktu rediģējams informācijas panelī (query_place_id nav obligāts):
Novirza arī jebkurš cits http(s) URL. geo: URI iztur data pārbaudi, bet tiek noraidīts kā mērķis, tāpēc neizmantojiet to. Viss pārējais darbojas tāpat kā veidam Website.
Request body

Lietotnes saite

qrType: "app". Ceļvedis informācijas panelim: Lietotnes saites QR kods.
Request body
Kļūdas:
  • 422 Invalid URL
  • 400 Missing destination URL

E-pasts

qrType: "email". Ceļvedis informācijas panelim: E-pasta QR kods.
Request body
Kļūdas:
  • 422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".

SMS

qrType: "sms". Ceļvedis informācijas panelim: SMS QR kods.
Request body
Kļūdas:
  • 422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".

WiFi

qrType: "wifi". Ceļvedis informācijas panelim: WiFi QR kods.
Request body
Kļūdas:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
Nemainiet izdrukāta WiFi QR koda veidu. Izdrukātie kodi saglabā veco tīklu.

PDF, Image un Video

qrType: "pdf", "image" vai "video". Ceļveži informācijas panelim: PDF, Image, Video. Viens fails uz QR kodu: PDF komplekti un attēlu galerijas API nav pieejami. Skatiet Nav pieejams API.
Kā augšupielādēt failu un iegūt tā fileId, skatiet Faili.

vCard

qrType: "vcard". Ceļvedis informācijas panelim: vCard QR kods. Galamērķa lapa un redaktors nolasa tikai tālāk norādītās rindu formas. Citi varianti, piemēram, TEL;CELL: vai EMAIL;TYPE=INTERNET:, tiek saglabāti, bet lapā neparādās.
  • N:<last>;<first>;;;: uzvārds un vārds. Veidotājs: abi obligāti, līdz 40 rakstzīmēm.
  • FN:<first> <last>: lapa to nenolasa. No tā tiek ņemts nosaukums informācijas paneļa sarakstā.
  • ORG:<company> un TITLE:<role>: uzņēmums un amats. Veidotājs: līdz 40 rakstzīmēm.
  • TEL;TYPE=HOME:, TEL;TYPE=CELL:, TEL;TYPE=WORK:, TEL;TYPE=FAX:: tālruņa, mobilā, darba un faksa numuri (+ un cipari).
  • EMAIL:<email>: e-pasta adrese.
  • URL:<url>: tīmekļa vietne.
  • NOTE:<text>: kopsavilkums. Aizsargājiet \\, \n, \; un \,. Veidotājs: līdz 200 rakstzīmēm.
  • ADR:;;<street>;<city>;<state>;<zip>;<country>: adrese.
  • X-SOCIALPROFILE;TYPE=<platform>:<url> vai URL;TYPE=<PLATFORM>:<url>: sociālo tīklu saites, viena rinda katrai platformai.
  • PHOTO;VALUE=URI:<url>: profila attēla URL. Tam ir priekšroka pār jebkuru faila ID.
  • X-GETQR-IMAGE-FILEID:<fileId>: profila attēls (target logo).
  • X-GETQR-PAGE-LOGO-FILEID:<fileId>: lapas logotips (target logo).
  • X-GETQR-LANDING-THEME:p|<0-4> vai X-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: lapas tēma, vai nu sagataves indekss (no 0 līdz 4), vai pielāgotas fona, pogu un ikonu krāsas.
Sociālās platformas: facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
Kļūdas:
  • 422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".

Social Media

qrType: "social". Ceļvedis informācijas panelim: Social Media QR kods. Lauki objektā data:
Request body
Kļūdas:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
qrType: "multilink". Ceļvedis informācijas panelim: Multi-Link QR kods. Lauki objektā data ir tādi paši kā veidam Social Media, tikai firstName, lastName un summary vietā ir: Masīvā customItems lauks logoFileId nav obligāts: tiek rādīta rezerves ikona. Veidotājs: vismaz viena sociālā tīkla saite vai viens netukšs pielāgots elements.
Request body
Kļūdas:
  • 422 Expected a JSON object describing the multi-link page for qrType "multilink".

Pasākums

qrType: "event". Ceļvedis informācijas panelim: Pasākuma QR kods. Lauki objektā data:
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
Kļūdas:
  • 422 Expected a JSON object describing the event page for qrType "event".

Faili QR kodos

Reģistrējiet failu ar Faili, augšupielādējiet to un pēc tam nododiet tā fileId. Izmantojiet lietojumam atbilstošo target:
  • pdf, image, video. PDF, Image vai Video QR koda saturs.
  • logo. Profila attēli, lapu logotipi, pielāgoto saišu ikonas un logotipi centrā.
Faili, kas nekad netiek piesaistīti QR kodam, pēc noteikta laika tiek dzēsti. fileId kļūdas, kas tiek atgrieztas izveidē un pieprasījumā PATCH, ja nosūtīts fileId: Failu ID saturā (fileId, pageLogoFileId, customItems[].logoFileId, rindas X-GETQR-*-FILEID) netiek validēti. Tie tiek attēloti tikai tad, ja augšupielādēti ar target logo. QR kods tos piesaista sev, tāpēc tīrīšana tos neskar.

Veida maiņa

qrType varat mainīt ar QR koda atjaunināšanu. Sūtiet jaunajam veidam atbilstošu data: saglabātais saturs pieder vecajam veidam, tāpēc maiņa bez tā tiek noraidīta. Pēc atjaunināšanas mērķis tiek noteikts šādā secībā:
  1. vcard, social, multilink, event: vienmēr mitinātā lapa.
  2. Informācijas panelī izveidots PDF komplekts vai attēlu galerija: tā lapa.
  3. pdf, image, video: faila URL (jauns fileId, citādi saglabātais).
  4. link.url, ja nosūtīts.
  5. Mainīts data.
  6. Saglabātais URL.
Ko dara katra maiņa:
  • No pdf, image vai video. Tiek notīrīts fileId un jebkurš komplekts vai galerija.
  • Uz pdf, image vai video. Nosūtiet arī fileId, citādi tiek atkārtoti izmantots saglabātais, kas var būt vCard fotoattēls.
  • No app. Tiek notīrīts lietotnes nosaukums, link.ios un link.android, tāpēc tālruņi seko jaunajam mērķim.
  • Uz wifi. Attēls pārslēdzas uz neapstrādātu saturu. Jau izdrukātie kodi joprojām satur īso saiti, kas tagad novirza uz wifi: URL.
  • No wifi. Izdrukātie kodi saglabā veco tīklu.
  • Uz vcard, social, multilink vai event. Īsā saite tiek novirzīta uz jauno mitināto lapu.
  • No vcard, social, multilink vai event. Sūtiet jaunu data. Mērķis seko tam.
Informācijas panelī izveidotiem statiskiem QR kodiem nav īsās saites, tāpēc to link.url maiņa atgriež 422. Šīs informācijas paneļa funkcijas nav daļa no v1 API. Nezināmi lauki tiek izmesti bez kļūdas, tāpēc to nosūtīšanai nav nekādas ietekmes. Informācijas panelī izveidotus komplektus un galerijas joprojām var nolasīt, pauzēt un dzēst ar API, bet to failus ar API mainīt nevar.

Biežākās problēmas

link.url izmanto shēmu, uz kuru īsā saite nevar novirzīt, piemēram, geo:, smsto:, matmsg: vai tel:. Izmantojiet šajā lapā norādītos formātus.
data ir tukšs, un nav link.url. Veidam app iestatiet vismaz vienu no link.ios, link.android, link.url vai data.
Saišu veidiem saglabātais data ir īsā saite. Mērķi nolasiet no url.
Lapa nolasa tikai tos laukus un rindu formas, kas norādītas šim veidam. Citi lauki tiek saglabāti, bet netiek rādīti.

Kas tālāk

QR kodi

Faili

Pielāgošana

Piekļuves noteikumi