Anpassning

GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.

Styla en QR-kod med de valfria objekten styles, frameOptions och logoOptions när du skapar eller uppdaterar den. Alla fält är valfria, och standardvärden gäller för allt du utelämnar. Samma tre objekt fungerar för QR-koder, mallar och massskapanden. Okända former, ramar eller logotyper avvisas med 422.

Exempel på designobjekt

{
  "styles": {
    "dotsOptions": { "type": "rounded", "color": "#000000" },
    "backgroundOptions": { "color": "#ffffff" },
    "cornersSquareOptions": { "type": "dot", "color": "#000000" },
    "cornersDotOptions": { "type": "dot", "color": "#000000" }
  },
  "frameOptions": { "id": "card", "text": "Scan me!", "color": "#000000", "textColor": "#ffffff" },
  "logoOptions": { "type": "suggested", "id": "logo-google", "scalePercent": 25 }
}

Skicka det tillsammans med resten av QR-koden:

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "styles": { "dotsOptions": { "type": "rounded", "color": "#1E40AF" } },
    "frameOptions": { "id": "card", "text": "Scan me!" },
    "logoOptions": { "type": "suggested", "id": "logo-website-3" }
  }'

Stilar

Objektet styles anger mönstrets former och färger.

Fält	Värden
`dotsOptions.type`	Formen på kroppens prickar: `square`, `dots`, `rounded`, `classy`, `classy-rounded`, `extra-rounded`
`cornersSquareOptions.type`	Formen på hörnrutan (ögats ram): `square`, `rounded`, `dot`, `classy-rounded`
`cornersDotOptions.type`	Formen på hörnpricken (ögonpupillen): `square`, `dot`, `dots`, `rounded`, `classy`
`dotsOptions.color`	Förgrundsfärg. Standard är `#000000`.
`backgroundOptions.color`	Bakgrundsfärg. Standard är `#ffffff`.
`cornersSquareOptions.color`, `cornersDotOptions.color`	Accepteras men har ingen effekt: hörnen använder alltid `dotsOptions.color`.

Färger. Bara hexvärden: #RGB eller #RRGGBB.
Felkorrigering. Alltid Q, och inte ett indatavärde. Om du skickar styles.qrOptions får du 422.
Varumärkes- och AI-designer. Kan inte anges via API:et. Om du skickar styles.logoQrArt får du 422.
Innehåll. styles.data ignoreras. Bilden kodar alltid QR-kodens innehåll.

Se till att det är tillräcklig kontrast mellan förgrunds- och bakgrundsfärgen, med mörk förgrund på ljus bakgrund. Koder med låg kontrast kanske inte går att skanna. Se Färger.

Ramar

Objektet frameOptions lägger till en dekorativ ram med en uppmaningstext runt QR-koden.

Fält	Beskrivning
`id`	Krävs när du skickar `frameOptions`. Ramtypen, från listorna nedan. `none` betyder ingen ram.
`text`	Uppmaningstext, högst 12 tecken. Standard är `Scan me!`.
`color`	Ramens färg, hex.
`textColor`	Textens färg, hex. Måste skilja sig från `color` när ramen visar en text, om inte paret är en av ramens inbyggda färgförinställningar.
`borderColor`	Kantlinjens färg, hex.
`fingerPrintColor`	Accentfärg för ramens ikon, hex.

Allmänna ramar

none, card, card-1, card-2, card-3, card-4, card-5, card-7, card-8, card-9, card-10, card-11, card-12, card-13, card-14, card-15, card-hor, wreath, envelope, waitress, coffee-cup, scooter, clipboardcard-hor visar ingen text.

Ramar per QR-kodstyp

Typ	Ramar med text	Ramar utan text
App Link	`app-3`	`app-1`, `app-2`
vCard	`contact-1`, `contact-5`	`contact-2`, `contact-3`, `contact-4`
Email	`email-1`	`email-2`, `email-3`, `email-4`, `email-5`
Feedback	—	`feedback-1`, `feedback-2`, `feedback-3`, `feedback-4`, `feedback-5`
Image	—	`image-1`, `image-2`, `image-3`, `image-4`, `image-5`, `image-6`
Location	`location-3`	`location-1`, `location-2`, `location-4`, `location-5`, `location-6`
Multi-Link	`multilink-3`	`multilink-1`, `multilink-2`
Payment	—	`payment-1`, `payment-2`, `payment-3`, `payment-4`, `payment-5`
PDF	`pdf-1`	`pdf-2`, `pdf-3`, `pdf-4`
SMS	`sms-3`, `sms-5`, `sms-7`	`sms-1`, `sms-2`, `sms-4`, `sms-6`
Social Media	`social-3`	`social-1`, `social-2`, `social-4`
Video	`video-1`, `video-3`	`video-2`, `video-4`, `video-5`, `video-6`
Website	`website-1`	`website-2`, `website-3`, `website-4`, `website-5`
WhatsApp	`whatsapp-2`	`whatsapp-1`, `whatsapp-3`, `whatsapp-4`
WiFi	—	`wifi-1`, `wifi-2`, `wifi-3`, `wifi-4`

Alla ramar fungerar med alla QR-kodstyper. Grupperingen följer instrumentpanelen.

Ramar utan text har inget fält för uppmaningstext i instrumentpanelen, och regeln att textColor måste skilja sig från color gäller inte för dem.

Logotyper

Objektet logoOptions placerar en logotyp i mitten av QR-koden. Ange type för att välja typ av logotyp.

Föreslagen logotyp

Sätt type till suggested och välj ett id från katalogen. Använd logo-none för ingen logotyp.

{ "logoOptions": { "type": "suggested", "id": "logo-instagram", "scalePercent": 25 } }

Alla id:n för föreslagna logotyper

logo-none, logo-website-3, logo-website-4, logo-link, logo-pdf-1, logo-pdf-2, logo-pdf-3, logo-picture-1, logo-picture-2, logo-picture-3, logo-picture-5, logo-picture-7, logo-picture-8, logo-video-1, logo-video-5, logo-whatsapp-1, logo-whatsapp-2, logo-whatsapp, logo-wifi-1, logo-wifi-2, logo-wifi-3, logo-wifi, logo-airbnb, logo-apple, logo-binance, logo-bitcoin, logo-bolt-food, logo-booking, logo-facebook, logo-glovo, logo-google, logo-google-maps, logo-google-play, logo-instagram, logo-linkedin, logo-location, logo-mail, logo-paypal, logo-stripe, logo-venmo, logo-cashapp, logo-braintree, logo-square, logo-verifone, logo-google-pay, logo-apple-pay, logo-klarna, logo-ayden, logo-giropay, logo-cartes-bancaires, logo-restaurant, logo-scan-me, logo-tripadvisor, logo-trustpilot, logo-uber-eats, logo-youtube, logo-spotify, logo-spotify-black

Egen logotyp

Ladda upp bilden

Registrera den med Filer med "target": "logo" och ladda sedan upp filen till den returnerade uploadUrl.

Referera till filen

Sätt type till uploaded och fileId till det returnerade fileId. fileId krävs, och det måste vara ett id som returnerats av slutpunkten för filer.

{ "logoOptions": { "type": "uploaded", "fileId": "file_7bQ2xR9mKp", "scalePercent": 35 } }

En okänd fil, en ofullständig uppladdning eller en fil som laddats upp för en annan target avvisas.

Logotypens storlek

scalePercent anger logotypens storlek i procent av QR-koden. Värdet är ett heltal från 15 till 45. Standard är 25. Andra värden, även kvoter som 0.25, får 422.

Uppdatera en design

Partiella uppdateringar. Vid Uppdatera en QR-kod slås styles, frameOptions och logoOptions samman med den sparade designen. Ett partiellt objekt ändrar bara det som det anger.
Byta logotyp. Om du väljer en annan logotyp ersätts den sparade, men dess scalePercent behålls.
Mallar. Med templateId vid skapande slås de fält du skickar samman ovanpå mallens design. Se Mallar.
Varumärkes- och AI-designer. En QR-kod med designKind branded eller ai har skapats i instrumentpanelen. API:et kan inte redigera dess bild, men behåller den när du ändrar andra fält.
Läsa en design. Svaren returnerar den sparade designen under design, i samma form som fälten i begäran, så att du kan skicka tillbaka den.

Vanliga problem

422 "Error correction is always Q and is not an input"

Ta bort styles.qrOptions från begäran.

422 "Frame caption is at most 12 characters"

Korta ned frameOptions.text till högst 12 tecken.

422 "Frame caption color must differ from the frame color"

textColor och color är samma på en ram som visar en text. Välj en kontrasterande textColor.

422 "Logo scale is a whole number from 15 to 45"

Skicka scalePercent som ett heltal i procent, till exempel 25, inte 0.25.

Hörnens färg ändras inte

Hörnen använder alltid dotsOptions.color. cornersSquareOptions.color och cornersDotOptions.color har ingen effekt.

API

Exempel på designobjekt

Stilar

Ramar

Logotyper

Föreslagen logotyp

Egen logotyp

Logotypens storlek

Uppdatera en design

Vanliga problem

Nästa steg

QR-koder

Mallar

Filer

Designöversikt

​Exempel på designobjekt

​Stilar

​Ramar

​Logotyper

​Föreslagen logotyp

​Egen logotyp

​Logotypens storlek

​Uppdatera en design

​Vanliga problem

​Nästa steg

QR-koder

Mallar

Filer

Designöversikt

Exempel på designobjekt

Stilar

Ramar

Logotyper

Föreslagen logotyp

Egen logotyp

Logotypens storlek

Uppdatera en design

Vanliga problem

Nästa steg