Hopp til hovedinnhold
GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.
Hver QR-kode har en qrType, og typen bestemmer hva data må inneholde. Denne veiledningen viser formatet for hver type, en body som fungerer, og hva du fortsatt kan endre etter at koden er trykt. Eksemplene er body for Opprett en QR-kode. Send dem slik:

Alle typer i oversikt

Slik løses en QR-kode

Hver QR-kode er en kortlenke pluss en payload. To felt bærer innholdet: Regler for alle typer:
  • Standardverdier. Ved oppretting blir en utelatt eller tom link.url satt til data, og du kan utelate hele link-objektet. Når begge sendes og er ulike, vinner link.url. Send dem like, eller send bare data.
  • Hva bildet koder. Bildet koder kortlenken for alle typer unntatt wifi. Derfor kan du endre hvor en trykt kode fører, og skanningene registreres. En WiFi-QR-kode koder selve nettverket: du kan ikke endre den etter trykk, og skanningene registreres ikke.
  • Skjemaer. link.url godtar bare http:, https:, wifi:, mailto:, sms: og begin:. Alt annet, også geo:, smsto:, matmsg: og tel:, gir 422 Invalid destination URL, selv der data godtar det.
  • Tom data. En tom data hopper over typekontrollen. For en videresendingstype må link.url da være satt, ellers gir kallet 400 Missing destination URL.
  • Form. Utover typekontrollen validerer ikke serveren payloaden. En JSON-type må bare kunne tolkes som et JSON-objekt, og et vCard må bare starte med BEGIN:VCARD.
Grenser merket Byggeren nedenfor er det redigeringsverktøyet i dashbordet håndhever. API-et godtar payloader som ignorerer dem, men de kan vises merkelig på landingssiden eller i redigeringsverktøyet.

Website

qrType: "website". Veiledning for dashbordet: Website-QR-kode.
Request body
Feil:
  • 422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".
  • 422 Invalid destination URL

Feedback

qrType: "feedback". Veiledning for dashbordet: Tilbakemeldings-QR-kode. data er http(s)-URL-en til tilbakemeldingsskjemaet, for eksempel et Google-skjema eller en anmeldelsesside. Alt annet fungerer som for Website.
Request body

Payment

qrType: "payment". Veiledning for dashbordet: Betalings-QR-kode. data er betalings-URL-en hos leverandøren, for eksempel:
Redigeringsverktøyet i dashbordet gjenkjenner disse vertene: paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link og payoneer.com. For PayPal er beløpet det siste segmentet i banen. Alle andre http(s)-URL-er fungerer også, men redigeringsverktøyet deler dem ikke opp i leverandør og beløp. Alt annet fungerer som for Website.
Request body

WhatsApp

qrType: "whatsapp". Veiledning for dashbordet: WhatsApp-QR-kode. data er en wa.me-lenke: det internasjonale nummeret i sifre uten +, eventuelt med en forhåndsutfylt tekst.
Serveren sjekker bare at det er en http(s)-URL. Dashbordet leser også api.whatsapp.com/send-lenker. Alt annet fungerer som for Website.
Request body

Location

qrType: "location". Veiledning for dashbordet: Steds-QR-kode. data er en kart-URL. Bruk dette formatet for at QR-koden fortsatt skal kunne redigeres i dashbordet (query_place_id er valgfritt):
Alle andre http(s)-URL-er videresender også. En geo:-URI består data-kontrollen, men avvises som mål, så ikke bruk den. Alt annet fungerer som for Website.
Request body
qrType: "app". Veiledning for dashbordet: App Link-QR-kode.
Request body
Feil:
  • 422 Invalid URL
  • 400 Missing destination URL

Email

qrType: "email". Veiledning for dashbordet: E-post-QR-kode.
Request body
Feil:
  • 422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".

SMS

qrType: "sms". Veiledning for dashbordet: SMS-QR-kode.
Request body
Feil:
  • 422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".

WiFi

qrType: "wifi". Veiledning for dashbordet: WiFi-QR-kode.
Request body
Feil:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
Ikke bytt type på en trykt WiFi-QR-kode. De trykte kodene beholder det gamle nettverket.

PDF, bilde og video

qrType: "pdf", "image" eller "video". Veiledninger for dashbordet: PDF, Image, Video. Én fil per QR-kode: PDF-pakker og bildegallerier er ikke tilgjengelige i API-et. Se Ikke støttet via API-et.
Se Filer for hvordan du laster opp filen og får fileId.

vCard

qrType: "vcard". Veiledning for dashbordet: vCard-QR-kode. Landingssiden og redigeringsverktøyet leser bare linjeformene nedenfor. Andre varianter, som TEL;CELL: eller EMAIL;TYPE=INTERNET:, lagres, men vises ikke på siden.
  • N:<last>;<first>;;;: etternavn og fornavn. Byggeren: begge påkrevd, opptil 40 tegn.
  • FN:<first> <last>: leses ikke av siden. Etiketten i listen i dashbordet kommer herfra.
  • ORG:<company> og TITLE:<role>: firma og stilling. Byggeren: opptil 40 tegn.
  • TEL;TYPE=HOME:, TEL;TYPE=CELL:, TEL;TYPE=WORK:, TEL;TYPE=FAX:: telefon-, mobil-, jobb- og faksnumre (+ og sifre).
  • EMAIL:<email>: e-postadresse.
  • URL:<url>: nettsted.
  • NOTE:<text>: sammendrag. Escape \\, \n, \; og \,. Byggeren: opptil 200 tegn.
  • ADR:;;<street>;<city>;<state>;<zip>;<country>: adresse.
  • X-SOCIALPROFILE;TYPE=<platform>:<url> eller URL;TYPE=<PLATFORM>:<url>: sosiale lenker, én linje per plattform.
  • PHOTO;VALUE=URI:<url>: URL til profilbilde. Går foran enhver fil-ID.
  • X-GETQR-IMAGE-FILEID:<fileId>: profilbilde (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 en indeks for et ferdig tema (0 til 4) eller egne farger for bakgrunn, knapper og ikoner.
Sosiale plattformer: facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
Feil:
  • 422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".

Social Media

qrType: "social". Veiledning for dashbordet: Social Media-QR-kode. Felt i data:
Request body
Feil:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
qrType: "multilink". Veiledning for dashbordet: Multi-Link-QR-kode. Feltene i data er de samme som for Social Media, bortsett fra at firstName, lastName og summary erstattes av: I customItems er logoFileId valgfri: et reserveikon vises. Byggeren: minst én sosial lenke eller ett eget element som ikke er tomt.
Request body
Feil:
  • 422 Expected a JSON object describing the multi-link page for qrType "multilink".

Event

qrType: "event". Veiledning for dashbordet: Arrangements-QR-kode. Felt 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
Feil:
  • 422 Expected a JSON object describing the event page for qrType "event".

Filer i QR-koder

Registrer en fil med Filer, last den opp, og send deretter fileId. Bruk det target som passer til bruken:
  • pdf, image, video. Innholdet i en PDF-, bilde- eller video-QR-kode.
  • logo. Profilbilder, sidelogoer, ikoner for egne lenker og logoer i midten.
Filer som aldri knyttes til en QR-kode, slettes etter en frist. fileId-feil, som returneres ved oppretting og ved PATCH når fileId sendes: Fil-ID-er inne i en payload (fileId, pageLogoFileId, customItems[].logoFileId, X-GETQR-*-FILEID-linjer) valideres ikke. De vises bare når de er lastet opp med target logo. QR-koden gjør krav på dem, så oppryddingen lar dem være.

Bytte type

Du kan endre qrType med Oppdater en QR-kode. Send data som passer til den nye typen: den lagrede payloaden tilhører den gamle typen, så et bytte uten den avvises. Etter en oppdatering bestemmes målet i denne rekkefølgen:
  1. vcard, social, multilink, event: alltid den hostede siden.
  2. En PDF-pakke eller et bildegalleri laget i dashbordet: landingssiden til den.
  3. pdf, image, video: filens URL (en ny fileId, ellers den lagrede).
  4. link.url, når den sendes.
  5. Endret data.
  6. Den lagrede URL-en.
Dette gjør hvert bytte:
  • Bort fra pdf, image eller video. fileId og eventuell pakke eller galleri fjernes.
  • Til pdf, image eller video. Send også fileId, ellers gjenbrukes den lagrede, som kan være et vCard-bilde.
  • Bort fra app. Appnavnet, link.ios og link.android fjernes, så telefoner følger det nye målet.
  • Til wifi. Bildet bytter til den rå payloaden. Koder som allerede er trykt, inneholder fortsatt kortlenken, som nå videresender til en wifi:-URL.
  • Bort fra wifi. Trykte koder beholder det gamle nettverket.
  • Til vcard, social, multilink eller event. Kortlenken pekes mot den nye hostede siden.
  • Bort fra vcard, social, multilink eller event. Send den nye data. Målet følger den.
Statiske QR-koder laget i dashbordet har ingen kortlenke, så å endre link.url for dem gir 422.

Ikke støttet via API-et

Disse funksjonene i dashbordet er ikke en del av v1-API-et. Ukjente felt forkastes uten feil, så det har ingen effekt å sende dem. Pakker og gallerier laget i dashbordet kan fortsatt hentes, settes på pause og slettes via API-et, men filene deres kan ikke endres via det.

Vanlige problemer

link.url bruker et skjema som kortlenken ikke kan videresende til, for eksempel geo:, smsto:, matmsg: eller tel:. Bruk formatene på denne siden.
data er tom, og det finnes ingen link.url. For app setter du minst én av link.ios, link.android, link.url eller data.
For lenketyper er den lagrede data kortlenken. Les målet fra url.
Siden leser bare feltene og linjeformene som er oppført for typen. Andre felt lagres, men vises ikke.

Neste steg

QR-koder

Filer

Tilpasning

Tilgangsregler