GetQR API’et er i beta og er tilgængeligt for udvalgte arbejdsområder. Detaljer kan ændre sig før den generelle udgivelse.
qrType, og typen bestemmer, hvad data skal indeholde. Denne vejledning viser formatet for hver type, en body, der virker, og hvad du stadig kan ændre, når koden er trykt.
Eksemplerne er bodies til Opret en QR-kode. Send dem sådan her:
Alle typer i overblik
Sådan løses en QR-kode
Hver QR-kode er et kortlink plus en payload. To felter bærer indholdet:
Regler for alle typer:
- Standardværdier. Ved oprettelse bliver en udeladt eller tom
link.urlsat tildata, og du kan udelade helelink-objektet. Når begge sendes og er forskellige, vinderlink.url. Send dem ens, eller send kundata. - Hvad billedet koder. Billedet koder kortlinket for alle typer undtagen
wifi. Derfor kan du ændre, hvor en trykt kode fører hen, og dens scanninger registreres. En WiFi-QR-kode koder selve netværket: Du kan ikke ændre den efter tryk, og dens scanninger registreres ikke. - Skemaer.
link.urlaccepterer kunhttp:,https:,wifi:,mailto:,sms:ogbegin:. Alt andet, herundergeo:,smsto:,matmsg:ogtel:, giver422 Invalid destination URL, også hvordataaccepterer det. - Tomme data. Tomme
dataspringer typekontrollen over. For en viderestillingstype skallink.urlså være angivet, ellers giver kaldet400 Missing destination URL. - Struktur. Ud over typekontrollen validerer serveren ikke payloaden. En JSON-type skal blot kunne parses som et JSON-objekt, og et vCard skal blot starte med
BEGIN:VCARD.
Website
qrType: "website". Vejledning til dashboardet: Website-QR-kode.
Request body
422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".422 Invalid destination URL
Feedback
qrType: "feedback". Vejledning til dashboardet: Feedback-QR-kode.
data er http(s)-URL’en til feedbackformularen, f.eks. en Google-formular eller en anmeldelsesside. Alt andet fungerer som for Website.
Request body
Payment
qrType: "payment". Vejledning til dashboardet: Betalings-QR-kode.
data er udbyderens betalings-URL, f.eks.:
paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link og payoneer.com. For PayPal er beløbet det sidste segment i stien. Alle andre http(s)-URL’er virker også, men editoren deler dem ikke op i udbyder og beløb. Alt andet fungerer som for Website.
Request body
qrType: "whatsapp". Vejledning til dashboardet: WhatsApp-QR-kode.
data er et wa.me-link: det internationale nummer med cifre uden +, eventuelt med en forudfyldt tekst.
api.whatsapp.com/send. Alt andet fungerer som for Website.
Request body
Location
qrType: "location". Vejledning til dashboardet: Lokations-QR-kode.
data er en kort-URL. Brug dette format, så QR-koden fortsat kan redigeres i dashboardet (query_place_id er valgfri):
geo:-URI består data-kontrollen, men afvises som destination, så brug den ikke. Alt andet fungerer som for Website.
Request body
App Link
qrType: "app". Vejledning til dashboardet: App Link-QR-kode.
Request body
422 Invalid URL400 Missing destination URL
qrType: "email". Vejledning til dashboardet: E-mail-QR-kode.
Request body
422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".
SMS
qrType: "sms". Vejledning til dashboardet: SMS-QR-kode.
Request body
422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".
WiFi
qrType: "wifi". Vejledning til dashboardet: WiFi-QR-kode.
Request body
422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
PDF, billede og video
qrType: "pdf", "image" eller "video". Vejledninger til dashboardet: PDF, Image, Video.
Én fil pr. QR-kode: PDF-pakker og billedgallerier er ikke tilgængelige via API’et. Se Ikke understøttet via API’et.
fileId.
vCard
qrType: "vcard". Vejledning til dashboardet: vCard-QR-kode.
Landingssiden og editoren læser kun linjeformerne nedenfor. Andre varianter, f.eks.
TEL;CELL: eller EMAIL;TYPE=INTERNET:, gemmes, men vises ikke på siden.
N:<last>;<first>;;;: efternavn og fornavn. Builder: begge påkrævet, op til 40 tegn.FN:<first> <last>: læses ikke af siden. Etiketten i listen i dashboardet kommer herfra.ORG:<company>ogTITLE:<role>: virksomhed og stilling. Builder: op til 40 tegn.TEL;TYPE=HOME:,TEL;TYPE=CELL:,TEL;TYPE=WORK:,TEL;TYPE=FAX:: telefon-, mobil-, arbejds- og faxnumre (+og cifre).EMAIL:<email>: e-mailadresse.URL:<url>: website.NOTE:<text>: resumé. Escape\\,\n,\;og\,. Builder: op til 200 tegn.ADR:;;<street>;<city>;<state>;<zip>;<country>: adresse.X-SOCIALPROFILE;TYPE=<platform>:<url>ellerURL;TYPE=<PLATFORM>:<url>: sociale links, én linje pr. platform.PHOTO;VALUE=URI:<url>: URL til profilbillede. Går forud for ethvert fil-id.X-GETQR-IMAGE-FILEID:<fileId>: profilbillede (targetlogo).X-GETQR-PAGE-LOGO-FILEID:<fileId>: sidelogo (targetlogo).X-GETQR-LANDING-THEME:p|<0-4>ellerX-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: tema for landingssiden, enten et forudindstillet indeks (0 til 4) eller egne farver til baggrund, knapper og ikoner.
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". Vejledning til dashboardet: Social Media-QR-kode.
Felter i
data:
Request body
422 Expected a JSON object describing the social profile page for qrType "social".
Multi-Link
qrType: "multilink". Vejledning til dashboardet: Multi-Link-QR-kode.
Felterne i
data er de samme som for Social Media, bortset fra at firstName, lastName og summary er erstattet af:
I
customItems er logoFileId valgfri: Der vises et reserveikon. Builder: mindst ét socialt link eller ét eget element, der ikke er tomt.
Request body
422 Expected a JSON object describing the multi-link page for qrType "multilink".
Event
qrType: "event". Vejledning til dashboardet: Event-QR-kode.
Felter i
data:
Eventtyper
Eventtyper
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, travelTourFaciliteter
Faciliteter
Request body
422 Expected a JSON object describing the event page for qrType "event".
Filer i QR-koder
Registrer en fil med Filer, upload den, og angiv derefter densfileId. Brug det target, der passer til formålet:
pdf,image,video. Indholdet i en PDF-, billed- eller video-QR-kode.logo. Profilbilleder, sidelogoer, ikoner til egne links og logoer i midten.
fileId-fejl, der returneres ved oprettelse og ved PATCH, når fileId sendes:
Fil-id’er i en payload (
fileId, pageLogoFileId, customItems[].logoFileId, X-GETQR-*-FILEID-linjer) valideres ikke. De vises kun, når de er uploadet med target logo. QR-koden gør krav på dem, så oprydningen lader dem være.
Skift af type
Du kan ændreqrType med Opdater en QR-kode. Send data, der passer til den nye type: Den gemte payload hører til den gamle type, så et skift uden nye data afvises.
Efter en opdatering bestemmes destinationen i denne rækkefølge:
vcard,social,multilink,event: altid den hostede side.- En PDF-pakke eller et billedgalleri lavet i dashboardet: dens landingsside.
pdf,image,video: filens URL (en nyfileId, ellers den gemte).link.url, når den sendes.- Ændrede
data. - Den gemte URL.
- Væk fra
pdf,imageellervideo.fileIdog eventuelle pakker eller gallerier ryddes. - Til
pdf,imageellervideo. Send ogsåfileId, ellers genbruges den gemte, som kan være et vCard-foto. - Væk fra
app. Appnavnet,link.iosoglink.androidryddes, så telefoner følger den nye destination. - Til
wifi. Billedet skifter til den rå payload. Koder, der allerede er trykt, indeholder stadig kortlinket, som nu viderestiller til enwifi:-URL. - Væk fra
wifi. Trykte koder beholder deres gamle netværk. - Til
vcard,social,multilinkellerevent. Kortlinket peges mod den nye hostede side. - Væk fra
vcard,social,multilinkellerevent. Send de nyedata. Destinationen følger dem.
link.url giver 422.
Ikke understøttet via API’et
Disse funktioner fra dashboardet er ikke en del af v1-API’et. Ukendte felter droppes uden fejl, så det har ingen effekt at sende dem.
Pakker og gallerier lavet i dashboardet kan stadig hentes, sættes på pause og slettes via API’et, men deres filer kan ikke ændres via det.
Almindelige problemer
422 Invalid destination URL
422 Invalid destination URL
link.url bruger et skema, som kortlinket ikke kan viderestille til, f.eks. geo:, smsto:, matmsg: eller tel:. Brug formaterne på denne side.400 Missing destination URL
400 Missing destination URL
data er tom, og der er ingen link.url. For app skal du angive mindst én af link.ios, link.android, link.url eller data.data i svaret er et kortlink, ikke min URL
data i svaret er et kortlink, ikke min URL
For linktyper er de gemte
data kortlinket. Læs destinationen fra url.Landingssiden mangler oplysninger fra min payload
Landingssiden mangler oplysninger fra min payload
Siden læser kun de felter og linjeformer, der er angivet for typen. Andre felter gemmes, men vises ikke.