Spring til hovedindhold
GetQR API’et er i beta og er tilgængeligt for udvalgte arbejdsområder. Detaljer kan ændre sig før den generelle udgivelse.
Hver QR-kode har en 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.url sat til data, og du kan udelade hele link-objektet. Når begge sendes og er forskellige, vinder link.url. Send dem ens, eller send kun data.
  • 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.url accepterer kun http:, https:, wifi:, mailto:, sms: og begin:. Alt andet, herunder geo:, smsto:, matmsg: og tel:, giver 422 Invalid destination URL, også hvor data accepterer det.
  • Tomme data. Tomme data springer typekontrollen over. For en viderestillingstype skal link.url så være angivet, ellers giver kaldet 400 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.
Grænser markeret med Builder nedenfor er dem, editoren i dashboardet håndhæver. API’et accepterer payloads, der ignorerer dem, men de kan blive vist forkert på landingssiden eller i editoren.

Website

qrType: "website". Vejledning til dashboardet: Website-QR-kode.
Request body
Fejl:
  • 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.:
Editoren i dashboardet genkender disse værter: 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

WhatsApp

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.
Serveren tjekker kun, at det er en http(s)-URL. Dashboardet læser også links af typen 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):
Alle andre http(s)-URL’er viderestiller også. En geo:-URI består data-kontrollen, men afvises som destination, så brug den ikke. Alt andet fungerer som for Website.
Request body
qrType: "app". Vejledning til dashboardet: App Link-QR-kode.
Request body
Fejl:
  • 422 Invalid URL
  • 400 Missing destination URL

Email

qrType: "email". Vejledning til dashboardet: E-mail-QR-kode.
Request body
Fejl:
  • 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
Fejl:
  • 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
Fejl:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
Skift ikke typen på en trykt WiFi-QR-kode. De trykte koder beholder det gamle netværk.

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.
Se Filer for at uploade filen og få dens 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> og TITLE:<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> eller URL;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 (target logo).
  • X-GETQR-PAGE-LOGO-FILEID:<fileId>: sidelogo (target logo).
  • X-GETQR-LANDING-THEME:p|<0-4> eller X-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.
Sociale platforme: facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
Fejl:
  • 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
Fejl:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
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
Fejl:
  • 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:
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
Fejl:
  • 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 dens fileId. 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.
Filer, der aldrig bliver knyttet til en QR-kode, slettes efter en frist. 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 ændre qrType 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:
  1. vcard, social, multilink, event: altid den hostede side.
  2. En PDF-pakke eller et billedgalleri lavet i dashboardet: dens landingsside.
  3. pdf, image, video: filens URL (en ny fileId, ellers den gemte).
  4. link.url, når den sendes.
  5. Ændrede data.
  6. Den gemte URL.
Hvad hvert skift gør:
  • Væk fra pdf, image eller video. fileId og eventuelle pakker eller gallerier ryddes.
  • Til pdf, image eller video. Send også fileId, ellers genbruges den gemte, som kan være et vCard-foto.
  • Væk fra app. Appnavnet, link.ios og link.android ryddes, 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 en wifi:-URL.
  • Væk fra wifi. Trykte koder beholder deres gamle netværk.
  • Til vcard, social, multilink eller event. Kortlinket peges mod den nye hostede side.
  • Væk fra vcard, social, multilink eller event. Send de nye data. Destinationen følger dem.
Statiske QR-koder lavet i dashboardet har intet kortlink, så ændring af deres 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

link.url bruger et skema, som kortlinket ikke kan viderestille til, f.eks. geo:, smsto:, matmsg: eller tel:. Brug formaterne på denne side.
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.
Siden læser kun de felter og linjeformer, der er angivet for typen. Andre felter gemmes, men vises ikke.

Næste skridt

QR-koder

Filer

Tilpasning

Adgangsregler