Hoppa till huvudinnehåll
GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.
Varje QR-kod har en 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.url lika med data, och du kan utelämna hela link-objektet. När båda skickas och skiljer sig åt vinner link.url. Skicka dem lika, eller skicka bara data.
  • 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.url accepterar bara http:, https:, wifi:, mailto:, sms: och begin:. Allt annat, även geo:, smsto:, matmsg: och tel:, får 422 Invalid destination URL, även där data accepterar det.
  • Tom data. En tom data hoppar över typkontrollen. För en omdirigeringstyp måste link.url då vara satt, annars får anropet 400 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.
Gränser märkta Redigeraren nedan är vad redigeraren i instrumentpanelen kräver. API:et accepterar payloads som struntar i dem, men de kan visas konstigt på landningssidan eller i redigeraren.

Website

qrType: "website". Guide för instrumentpanelen: Website-QR-kod.
Request body
Fel:
  • 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:
Redigeraren i instrumentpanelen känner igen de här värdarna: 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

WhatsApp

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.
Servern kontrollerar bara att det är en http(s)-URL. Instrumentpanelen läser också 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):
Andra http(s)-URL:er omdirigerar också. En geo:-URI klarar data-kontrollen men avvisas som mål, så använd den inte. Allt annat fungerar som för Website.
Request body
qrType: "app". Guide för instrumentpanelen: App Link-QR-kod.
Request body
Fel:
  • 422 Invalid URL
  • 400 Missing destination URL

Email

qrType: "email". Guide för instrumentpanelen: Email-QR-kod.
Request body
Fel:
  • 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
Fel:
  • 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
Fel:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
Byt inte typ på en tryckt WiFi-QR-kod. De tryckta koderna behåller det gamla nätverket.

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.
Hur du laddar upp filen och får dess 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> och TITLE:<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> eller URL;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 (target logo).
  • X-GETQR-PAGE-LOGO-FILEID:<fileId>: sidlogotyp (target logo).
  • X-GETQR-LANDING-THEME:p|<0-4> eller X-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.
Sociala plattformar: facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
Fel:
  • 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
Fel:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
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
Fel:
  • 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:
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
Fel:
  • 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 dess fileId. 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.
Filer som aldrig kopplas till en QR-kod raderas efter en karenstid. Fel för 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 ändra qrType 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:
  1. vcard, social, multilink, event: alltid den hostade sidan.
  2. Ett PDF-paket eller bildgalleri som skapats i instrumentpanelen: dess landningssida.
  3. pdf, image, video: filens URL (ett nytt fileId, annars det sparade).
  4. link.url, när den skickas.
  5. Ändrad data.
  6. Den sparade URL:en.
Vad varje typbyte gör:
  • Från pdf, image eller video. fileId och eventuella paket eller gallerier rensas.
  • Till pdf, image eller video. Skicka även fileId, annars återanvänds det sparade, som kan vara ett vCard-foto.
  • Från app. Appnamnet, link.ios och link.android rensas, 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 en wifi:-URL.
  • Från wifi. Tryckta koder behåller sitt gamla nätverk.
  • Till vcard, social, multilink eller event. Den korta länken pekas om till den nya hostade sidan.
  • Från vcard, social, multilink eller event. Skicka den nya data. Målet följer den.
Statiska QR-koder som skapats i instrumentpanelen har ingen kort länk, så om du ändrar deras 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

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.
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.
För länktyper är den sparade data den korta länken. Läs målet från url.
Sidan läser bara de fält och radformer som listas för typen. Andra fält sparas men visas inte.

Nästa steg

QR-koder

Filer

Anpassning

Åtkomstregler