API-ul GetQR este în versiune beta și este disponibil pentru anumite spații de lucru. Detaliile se pot schimba înainte de lansarea generală.
qrType, iar tipul stabilește ce trebuie să conțină data. Acest ghid prezintă formatul fiecărui tip, un corp de cerere funcțional și ce mai puteți schimba după ce codul a fost tipărit.
Exemplele sunt corpuri de cerere pentru Crearea unui cod QR. Trimiteți-le astfel:
Toate tipurile pe scurt
Cum se rezolvă un cod QR
Fiecare cod QR este un link scurt plus un payload. Conținutul este purtat de două câmpuri:
Reguli pentru toate tipurile:
- Valori implicite. La creare, un
link.urlomis sau gol devinedatași puteți omite întregul obiectlink. Când ambele sunt trimise și diferă, are prioritatelink.url. Trimiteți-le egale sau trimiteți doardata. - Ce codifică imaginea. Imaginea codifică linkul scurt pentru toate tipurile, cu excepția
wifi. Astfel, puteți schimba unde duce un cod tipărit, iar scanările lui sunt urmărite. Un cod QR WiFi codifică rețeaua însăși: nu îl puteți schimba după tipărire, iar scanările lui nu sunt urmărite. - Scheme.
link.urlacceptă doarhttp:,https:,wifi:,mailto:,sms:șibegin:. Orice altceva, inclusivgeo:,smsto:,matmsg:șitel:, primește422 Invalid destination URL, chiar și acolo undedatale acceptă. - Date goale. Un
datagol sare peste verificarea tipului. Pentru un tip de redirecționare,link.urltrebuie atunci să fie setat, altfel apelul primește400 Missing destination URL. - Structură. În afară de verificarea tipului, serverul nu validează payloadul. Un tip JSON trebuie doar să poată fi parsat ca obiect JSON, iar un vCard trebuie doar să înceapă cu
BEGIN:VCARD.
Website
qrType: "website". Ghid pentru panou: Cod QR Website.
Request body
422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".422 Invalid destination URL
Feedback
qrType: "feedback". Ghid pentru panou: Cod QR Feedback.
data este URL-ul http(s) al formularului de feedback, de exemplu un Google Form sau o pagină de recenzii. Restul funcționează ca la Website.
Request body
Payment
qrType: "payment". Ghid pentru panou: Cod QR Payment.
data este URL-ul de plată al furnizorului, de exemplu:
paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link și payoneer.com. Pentru PayPal, suma este ultimul segment al căii. Funcționează și orice alt URL http(s), dar editorul nu îl va separa în furnizor și sumă. Restul funcționează ca la Website.
Request body
qrType: "whatsapp". Ghid pentru panou: Cod QR WhatsApp.
data este un link wa.me: numărul internațional format doar din cifre, fără +, opțional cu un text precompletat.
api.whatsapp.com/send. Restul funcționează ca la Website.
Request body
Location
qrType: "location". Ghid pentru panou: Cod QR Location.
data este un URL de hartă. Folosiți acest format pentru ca codul QR să rămână editabil în panou (query_place_id este opțional):
geo: trece de verificarea lui data, dar este respins ca destinație, așa că nu îl folosiți. Restul funcționează ca la Website.
Request body
App Link
qrType: "app". Ghid pentru panou: Cod QR App Link.
Request body
422 Invalid URL400 Missing destination URL
qrType: "email". Ghid pentru panou: Cod QR Email.
Request body
422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".
SMS
qrType: "sms". Ghid pentru panou: Cod QR SMS.
Request body
422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".
WiFi
qrType: "wifi". Ghid pentru panou: Cod QR WiFi.
Request body
422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
PDF și fișiere imagine sau video
qrType: "pdf", "image" sau "video". Ghiduri pentru panou: PDF, Image, Video.
Un singur fișier per cod QR: pachetele PDF și galeriile de imagini nu sunt disponibile prin API. Consultați Nu este acceptat prin API.
fileId, consultați Fișiere.
vCard
qrType: "vcard". Ghid pentru panou: Cod QR vCard.
Pagina de destinație și editorul citesc doar formele de linie de mai jos. Alte variante, cum ar fi
TEL;CELL: sau EMAIL;TYPE=INTERNET:, sunt stocate, dar nu apar pe pagină.
N:<last>;<first>;;;: numele și prenumele. Editor: ambele obligatorii, până la 40 de caractere.FN:<first> <last>: nu este citit de pagină. Din el provine eticheta din lista panoului.ORG:<company>șiTITLE:<role>: compania și funcția. Editor: până la 40 de caractere.TEL;TYPE=HOME:,TEL;TYPE=CELL:,TEL;TYPE=WORK:,TEL;TYPE=FAX:: numere de telefon, mobil, serviciu și fax (+și cifre).EMAIL:<email>: adresa de e-mail.URL:<url>: website.NOTE:<text>: rezumat. Escapați\\,\n,\;și\,. Editor: până la 200 de caractere.ADR:;;<street>;<city>;<state>;<zip>;<country>: adresa.X-SOCIALPROFILE;TYPE=<platform>:<url>sauURL;TYPE=<PLATFORM>:<url>: linkuri sociale, câte o linie pentru fiecare platformă.PHOTO;VALUE=URI:<url>: URL-ul imaginii de profil. Are prioritate față de orice ID de fișier.X-GETQR-IMAGE-FILEID:<fileId>: imaginea de profil (targetlogo).X-GETQR-PAGE-LOGO-FILEID:<fileId>: logoul paginii (targetlogo).X-GETQR-LANDING-THEME:p|<0-4>sauX-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: tema paginii de destinație, fie un index de presetare (de la 0 la 4), fie culori personalizate pentru fundal, buton și pictograme.
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". Ghid pentru panou: Cod QR Social Media.
Câmpuri în
data:
Request body
422 Expected a JSON object describing the social profile page for qrType "social".
Multi-Link
qrType: "multilink". Ghid pentru panou: Cod QR Multi-Link.
Câmpurile din
data sunt cele de la Social Media, cu excepția faptului că firstName, lastName și summary sunt înlocuite cu:
În
customItems, logoFileId este opțional: se afișează o pictogramă de rezervă. Editor: cel puțin un link social sau un element personalizat care nu este gol.
Request body
422 Expected a JSON object describing the multi-link page for qrType "multilink".
Event
qrType: "event". Ghid pentru panou: Cod QR Event.
Câmpuri în
data:
Tipuri de evenimente
Tipuri de evenimente
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, travelTourFacilități
Facilități
Request body
422 Expected a JSON object describing the event page for qrType "event".
Fișiere în codurile QR
Înregistrați un fișier cu Fișiere, încărcați-l, apoi transmitețifileId. Folosiți targetul care corespunde utilizării:
pdf,image,video. Conținutul unui cod QR PDF, Image sau Video.logo. Imagini de profil, logouri de pagină, pictograme pentru linkuri personalizate și logouri centrale.
fileId, returnate la creare și la PATCH când se trimite fileId:
ID-urile de fișiere din interiorul unui payload (
fileId, pageLogoFileId, customItems[].logoFileId, liniile X-GETQR-*-FILEID) nu sunt validate. Ele sunt afișate doar dacă au fost încărcate cu targetul logo. Codul QR le revendică, așa că procesul de curățare nu le atinge.
Schimbarea tipului
Puteți schimbaqrType cu Actualizarea unui cod QR. Trimiteți un data care corespunde noului tip: payloadul stocat aparține tipului vechi, așa că o schimbare fără el este respinsă.
După o actualizare, destinația se stabilește în această ordine:
vcard,social,multilink,event: întotdeauna pagina găzduită.- Un pachet PDF sau o galerie de imagini creată în panou: pagina sa de destinație.
pdf,image,video: URL-ul fișierului (unfileIdnou, altfel cel stocat).link.url, când este trimis.datamodificat.- URL-ul stocat.
- Din
pdf,imagesauvideo.fileIdși orice pachet sau galerie sunt șterse. - În
pdf,imagesauvideo. Trimiteți șifileId, altfel este refolosit cel stocat, care poate fi o fotografie vCard. - Din
app. Numele aplicației,link.iosșilink.androidsunt șterse, așa că telefoanele urmează noua destinație. - În
wifi. Imaginea trece la payloadul brut. Codurile deja tipărite conțin în continuare linkul scurt, care acum redirecționează către un URLwifi:. - Din
wifi. Codurile tipărite își păstrează rețeaua veche. - În
vcard,social,multilinksauevent. Linkul scurt este îndreptat către noua pagină găzduită. - Din
vcard,social,multilinksauevent. Trimiteți nouldata. Destinația îl urmează.
link.url pentru ele primește 422.
Nu este acceptat prin API
Aceste funcții din panou nu fac parte din API-ul v1. Câmpurile necunoscute sunt eliminate fără eroare, așa că trimiterea lor nu are niciun efect.
Pachetele și galeriile create în panou pot fi în continuare citite, puse în pauză și șterse prin API, dar fișierele lor nu pot fi modificate prin API.
Probleme frecvente
422 Invalid destination URL
422 Invalid destination URL
link.url folosește o schemă către care linkul scurt nu poate redirecționa, cum ar fi geo:, smsto:, matmsg: sau tel:. Folosiți formatele de pe această pagină.400 Missing destination URL
400 Missing destination URL
data este gol și nu există link.url. Pentru app, setați cel puțin unul dintre link.ios, link.android, link.url sau data.data din răspuns este un link scurt, nu URL-ul meu
data din răspuns este un link scurt, nu URL-ul meu
Pentru tipurile de tip link,
data stocat este linkul scurt. Citiți destinația din url.Pagina de destinație nu afișează unele detalii din payload
Pagina de destinație nu afișează unele detalii din payload
Pagina citește doar câmpurile și formele de linie enumerate pentru tipul respectiv. Celelalte câmpuri sunt stocate, dar nu sunt afișate.