GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.
qrType, och typen avgör vad data måste innehålla. Den här guiden visar formatet för varje typ, en body som fungerar och vad du fortfarande kan ändra när koden har tryckts.
Exemplen är bodyn för Skapa en QR-kod. Skicka dem så här:
Alla typer i överblick
Hur en QR-kod löses in
Varje QR-kod är en kort länk plus en payload. Två fält bär innehållet:
Regler för alla typer:
- Standardvärden. Vid skapande blir en utelämnad eller tom
link.urllika meddata, och du kan utelämna helalink-objektet. När båda skickas och skiljer sig åt vinnerlink.url. Skicka dem lika, eller skicka baradata. - Vad bilden kodar. Bilden kodar den korta länken för alla typer utom
wifi. Därför kan du ändra vart en tryckt kod leder, och dess skanningar registreras. En WiFi-QR-kod kodar själva nätverket: den kan inte ändras efter tryck, och dess skanningar registreras inte. - Scheman.
link.urlaccepterar barahttp:,https:,wifi:,mailto:,sms:ochbegin:. Allt annat, ävengeo:,smsto:,matmsg:ochtel:, får422 Invalid destination URL, även därdataaccepterar det. - Tom data. En tom
datahoppar över typkontrollen. För en omdirigeringstyp måstelink.urldå vara satt, annars får anropet400 Missing destination URL. - Form. Utöver typkontrollen validerar servern inte payloaden. En JSON-typ behöver bara gå att tolka som ett JSON-objekt, och ett vCard behöver bara börja med
BEGIN:VCARD.
Website
qrType: "website". Guide för instrumentpanelen: Website-QR-kod.
Request body
422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".422 Invalid destination URL
Feedback
qrType: "feedback". Guide för instrumentpanelen: Feedback-QR-kod.
data är http(s)-URL:en till feedbackformuläret, till exempel ett Google-formulär eller en recensionssida. Allt annat fungerar som för Website.
Request body
Payment
qrType: "payment". Guide för instrumentpanelen: Payment-QR-kod.
data är leverantörens betal-URL, till exempel:
paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link och payoneer.com. För PayPal är beloppet det sista segmentet i sökvägen. Andra http(s)-URL:er fungerar också, men redigeraren delar inte upp dem i leverantör och belopp. Allt annat fungerar som för Website.
Request body
qrType: "whatsapp". Guide för instrumentpanelen: WhatsApp-QR-kod.
data är en wa.me-länk: det internationella numret med siffror utan +, eventuellt med en förifylld text.
api.whatsapp.com/send-länkar. Allt annat fungerar som för Website.
Request body
Location
qrType: "location". Guide för instrumentpanelen: Location-QR-kod.
data är en kart-URL. Använd det här formatet för att QR-koden ska gå att redigera i instrumentpanelen (query_place_id är valfritt):
geo:-URI klarar data-kontrollen men avvisas som mål, så använd den inte. Allt annat fungerar som för Website.
Request body
App Link
qrType: "app". Guide för instrumentpanelen: App Link-QR-kod.
Request body
422 Invalid URL400 Missing destination URL
qrType: "email". Guide för instrumentpanelen: Email-QR-kod.
Request body
422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".
SMS
qrType: "sms". Guide för instrumentpanelen: SMS-QR-kod.
Request body
422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".
WiFi
qrType: "wifi". Guide för instrumentpanelen: WiFi-QR-kod.
Request body
422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
PDF, Image och Video
qrType: "pdf", "image" eller "video". Guider för instrumentpanelen: PDF, Image, Video.
En fil per QR-kod: PDF-paket och bildgallerier finns inte i API:et. Se Stöds inte via API:et.
fileId beskrivs i Filer.
vCard
qrType: "vcard". Guide för instrumentpanelen: vCard-QR-kod.
Landningssidan och redigeraren läser bara radformerna nedan. Andra varianter, som
TEL;CELL: eller EMAIL;TYPE=INTERNET:, sparas men visas inte på sidan.
N:<last>;<first>;;;: efternamn och förnamn. Redigeraren: båda krävs, högst 40 tecken.FN:<first> <last>: läses inte av sidan. Etiketten i listan i instrumentpanelen kommer härifrån.ORG:<company>ochTITLE:<role>: företag och roll. Redigeraren: högst 40 tecken.TEL;TYPE=HOME:,TEL;TYPE=CELL:,TEL;TYPE=WORK:,TEL;TYPE=FAX:: telefon-, mobil-, arbets- och faxnummer (+och siffror).EMAIL:<email>: e-postadress.URL:<url>: webbplats.NOTE:<text>: sammanfattning. Skydda\\,\n,\;och\,. Redigeraren: högst 200 tecken.ADR:;;<street>;<city>;<state>;<zip>;<country>: adress.X-SOCIALPROFILE;TYPE=<platform>:<url>ellerURL;TYPE=<PLATFORM>:<url>: sociala länkar, en rad per plattform.PHOTO;VALUE=URI:<url>: URL till profilbild. Går före alla fil-id:n.X-GETQR-IMAGE-FILEID:<fileId>: profilbild (targetlogo).X-GETQR-PAGE-LOGO-FILEID:<fileId>: sidlogotyp (targetlogo).X-GETQR-LANDING-THEME:p|<0-4>ellerX-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: landningssidans tema, antingen ett förinställt index (0 till 4) eller egna färger för bakgrund, knappar och 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". Guide för instrumentpanelen: Social Media-QR-kod.
Fält i
data:
Request body
422 Expected a JSON object describing the social profile page for qrType "social".
Multi-Link
qrType: "multilink". Guide för instrumentpanelen: Multi-Link-QR-kod.
Fälten i
data är desamma som för Social Media, förutom att firstName, lastName och summary ersätts av:
I
customItems är logoFileId valfritt: en reservikon visas. Redigeraren: minst en social länk eller ett eget objekt som inte är tomt.
Request body
422 Expected a JSON object describing the multi-link page for qrType "multilink".
Event
qrType: "event". Guide för instrumentpanelen: Event-QR-kod.
Fält i
data:
Evenemangstyper
Evenemangstyper
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
Registrera en fil med Filer, ladda upp den och skicka sedan dessfileId. Använd den target som matchar användningen:
pdf,image,video. Innehållet i en PDF-, bild- eller video-QR-kod.logo. Profilbilder, sidlogotyper, ikoner för egna länkar och logotyper i mitten.
fileId, som returneras vid skapande och vid PATCH när fileId skickas:
Fil-id:n inuti en payload (
fileId, pageLogoFileId, customItems[].logoFileId, X-GETQR-*-FILEID-rader) valideras inte. De visas bara om de laddats upp med target logo. QR-koden gör anspråk på dem, så rensningen lämnar dem i fred.
Byta typ
Du kan ändraqrType med Uppdatera en QR-kod. Skicka data som matchar den nya typen: den sparade payloaden hör till den gamla typen, så ett typbyte utan den avvisas.
Efter en uppdatering bestäms målet i den här ordningen:
vcard,social,multilink,event: alltid den hostade sidan.- Ett PDF-paket eller bildgalleri som skapats i instrumentpanelen: dess landningssida.
pdf,image,video: filens URL (ett nyttfileId, annars det sparade).link.url, när den skickas.- Ändrad
data. - Den sparade URL:en.
- Från
pdf,imageellervideo.fileIdoch eventuella paket eller gallerier rensas. - Till
pdf,imageellervideo. Skicka ävenfileId, annars återanvänds det sparade, som kan vara ett vCard-foto. - Från
app. Appnamnet,link.iosochlink.androidrensas, så att telefoner följer det nya målet. - Till
wifi. Bilden byts till den råa payloaden. Koder som redan har tryckts innehåller fortfarande den korta länken, som nu omdirigerar till enwifi:-URL. - Från
wifi. Tryckta koder behåller sitt gamla nätverk. - Till
vcard,social,multilinkellerevent. Den korta länken pekas om till den nya hostade sidan. - Från
vcard,social,multilinkellerevent. Skicka den nyadata. Målet följer den.
link.url får du 422.
Stöds inte via API:et
De här funktionerna i instrumentpanelen ingår inte i v1-API:et. Okända fält ignoreras utan fel, så att skicka dem har ingen effekt.
Paket och gallerier som skapats i instrumentpanelen kan fortfarande läsas, pausas och tas bort via API:et, men deras filer kan inte ändras via det.
Vanliga problem
422 Invalid destination URL
422 Invalid destination URL
link.url använder ett schema som den korta länken inte kan omdirigera till, som geo:, smsto:, matmsg: eller tel:. Använd formaten på den här sidan.400 Missing destination URL
400 Missing destination URL
data är tom och det finns ingen link.url. För app anger du minst ett av link.ios, link.android, link.url eller data.data i svaret är en kort länk, inte min URL
data i svaret är en kort länk, inte min URL
För länktyper är den sparade
data den korta länken. Läs målet från url.Landningssidan saknar uppgifter från min payload
Landningssidan saknar uppgifter från min payload
Sidan läser bara de fält och radformer som listas för typen. Andra fält sparas men visas inte.