GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.
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.urlsatt tildata, og du kan utelate helelink-objektet. Når begge sendes og er ulike, vinnerlink.url. Send dem like, eller send baredata. - 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.urlgodtar barehttp:,https:,wifi:,mailto:,sms:ogbegin:. Alt annet, ogsågeo:,smsto:,matmsg:ogtel:, gir422 Invalid destination URL, selv derdatagodtar det. - Tom data. En tom
datahopper over typekontrollen. For en videresendingstype målink.urlda være satt, ellers gir kallet400 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.
Website
qrType: "website". Veiledning for dashbordet: 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". 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:
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
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.
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):
geo:-URI består data-kontrollen, men avvises som mål, så ikke bruk den. Alt annet fungerer som for Website.
Request body
App Link
qrType: "app". Veiledning for dashbordet: App Link-QR-kode.
Request body
422 Invalid URL400 Missing destination URL
qrType: "email". Veiledning for dashbordet: E-post-QR-kode.
Request body
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
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
422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
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.
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>ogTITLE:<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>ellerURL;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 (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 en indeks for et ferdig tema (0 til 4) eller egne farger for bakgrunn, 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". Veiledning for dashbordet: Social Media-QR-kode.
Felt i
data:
Request body
422 Expected a JSON object describing the social profile page for qrType "social".
Multi-Link
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
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:
Arrangementstyper
Arrangementstyper
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, travelTourFasiliteter
Fasiliteter
Request body
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 deretterfileId. 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.
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 endreqrType 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:
vcard,social,multilink,event: alltid den hostede siden.- En PDF-pakke eller et bildegalleri laget i dashbordet: landingssiden til den.
pdf,image,video: filens URL (en nyfileId, ellers den lagrede).link.url, når den sendes.- Endret
data. - Den lagrede URL-en.
- Bort fra
pdf,imageellervideo.fileIdog eventuell pakke eller galleri fjernes. - Til
pdf,imageellervideo. Send ogsåfileId, ellers gjenbrukes den lagrede, som kan være et vCard-bilde. - Bort fra
app. Appnavnet,link.iosoglink.androidfjernes, 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 enwifi:-URL. - Bort fra
wifi. Trykte koder beholder det gamle nettverket. - Til
vcard,social,multilinkellerevent. Kortlenken pekes mot den nye hostede siden. - Bort fra
vcard,social,multilinkellerevent. Send den nyedata. Målet følger den.
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
422 Invalid destination URL
422 Invalid destination URL
link.url bruker et skjema som kortlenken ikke kan videresende til, for eksempel geo:, smsto:, matmsg: eller tel:. Bruk formatene på denne siden.400 Missing destination URL
400 Missing destination URL
data er tom, og det finnes ingen link.url. For app setter du minst én av link.ios, link.android, link.url eller data.data i svaret er en kortlenke, ikke URL-en min
data i svaret er en kortlenke, ikke URL-en min
For lenketyper er den lagrede
data kortlenken. Les målet fra url.Landingssiden mangler detaljer fra payloaden min
Landingssiden mangler detaljer fra payloaden min
Siden leser bare feltene og linjeformene som er oppført for typen. Andre felt lagres, men vises ikke.