Personalizacja

API GetQR jest w wersji beta i jest dostępne dla wybranych obszarów roboczych. Szczegóły mogą się zmienić przed ogólną premierą.

Nadaj styl kodowi QR za pomocą opcjonalnych obiektów styles, frameOptions i logoOptions przy jego tworzeniu lub aktualizacji. Wszystkie pola są opcjonalne, a dla pominiętych obowiązują wartości domyślne. Te same trzy obiekty działają w kodach QR, szablonach i masowym tworzeniu. Nieznane kształty, ramki lub logo są odrzucane z kodem 422.

Przykładowy obiekt projektu

{
  "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 }
}

Wyślij go razem z resztą danych kodu QR:

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" }
  }'

Style

Obiekt styles ustawia kształty i kolory wzoru.

Pole	Wartości
`dotsOptions.type`	Kształt kropek korpusu: `square`, `dots`, `rounded`, `classy`, `classy-rounded`, `extra-rounded`
`cornersSquareOptions.type`	Kształt narożnego kwadratu (ramki oka): `square`, `rounded`, `dot`, `classy-rounded`
`cornersDotOptions.type`	Kształt narożnej kropki (źrenicy oka): `square`, `dot`, `dots`, `rounded`, `classy`
`dotsOptions.color`	Kolor pierwszego planu. Domyślnie `#000000`.
`backgroundOptions.color`	Kolor tła. Domyślnie `#ffffff`.
`cornersSquareOptions.color`, `cornersDotOptions.color`	Akceptowane, ale bez efektu: narożniki zawsze mają kolor `dotsOptions.color`.

Kolory. Tylko wartości szesnastkowe: #RGB lub #RRGGBB.
Korekcja błędów. Zawsze Q i nie da się jej ustawić. Wysłanie styles.qrOptions zwraca 422.
Projekty Branded i AI. Nie da się ich ustawić przez API. Wysłanie styles.logoQrArt zwraca 422.
Treść. styles.data jest ignorowane. Obraz zawsze koduje treść kodu QR.

Zachowaj wystarczający kontrast między kolorem pierwszego planu a tłem: ciemny pierwszy plan na jasnym tle. Kody o niskim kontraście mogą się nie skanować. Zobacz Kolory.

Ramki

Obiekt frameOptions dodaje wokół kodu QR dekoracyjną ramkę z wezwaniem do działania.

Pole	Opis
`id`	Wymagane, gdy wysyłasz `frameOptions`. Typ ramki z poniższych list. `none` oznacza brak ramki.
`text`	Etykieta wezwania do działania, do 12 znaków. Domyślnie `Scan me!`.
`color`	Kolor ramki, wartość szesnastkowa.
`textColor`	Kolor etykiety, wartość szesnastkowa. Musi różnić się od `color`, gdy ramka pokazuje etykietę, chyba że para jest jednym z wbudowanych zestawów kolorów ramki.
`borderColor`	Kolor obramowania, wartość szesnastkowa.
`fingerPrintColor`	Kolor akcentu ikony ramki, wartość szesnastkowa.

Ramki ogólne

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 nie pokazuje etykiety.

Ramki według typu kodu QR

Typ	Ramki z etykietą	Ramki bez etykiety
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`

Każda ramka działa z każdym typem kodu QR. Podział odpowiada temu w panelu.

Ramki bez etykiety nie mają w panelu pola wezwania do działania i nie dotyczy ich reguła, że textColor musi różnić się od color.

Logo

Obiekt logoOptions umieszcza logo na środku kodu QR. Ustaw type, aby wybrać rodzaj logo.

Sugerowane logo

Ustaw type na suggested i wybierz id z katalogu. Aby nie używać logo, użyj logo-none.

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

Wszystkie ID sugerowanych logo

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

Własne logo

Prześlij obraz

Zarejestruj go przez Pliki z "target": "logo", a następnie prześlij plik na zwrócony uploadUrl.

Wskaż plik

Ustaw type na uploaded, a fileId na zwrócony fileId. fileId jest wymagany i musi to być ID zwrócone przez endpoint plików.

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

Nieznany plik, niedokończone przesyłanie lub plik przesłany dla innego celu (target) są odrzucane.

Rozmiar logo

scalePercent ustawia rozmiar logo jako procent kodu QR. Przyjmuje liczbę całkowitą od 15 do 45. Domyślnie 25. Inne wartości, w tym ułamki takie jak 0.25, zwracają 422.

Aktualizacja projektu

Częściowe aktualizacje. Przy aktualizacji kodu QR obiekty styles, frameOptions i logoOptions są scalane z zapisanym projektem. Częściowy obiekt zmienia tylko to, co zawiera.
Zmiana logo. Wybranie innego logo zastępuje zapisane, ale zachowuje jego scalePercent.
Szablony. Gdy przy tworzeniu podasz templateId, wysłane pola są scalane z projektem szablonu i mają przed nim pierwszeństwo. Zobacz Szablony.
Projekty Branded i AI. Kod QR z designKind równym branded lub ai został utworzony w panelu. API nie może edytować jego grafiki, ale zachowuje ją, gdy zmieniasz inne pola.
Odczyt projektu. Odpowiedzi zwracają zapisany projekt w polu design, w tym samym kształcie co pola żądania, więc możesz go odesłać.

Typowe problemy

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

Usuń styles.qrOptions z żądania.

422 "Frame caption is at most 12 characters"

Skróć frameOptions.text do 12 znaków lub mniej.

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

textColor i color są takie same w ramce, która pokazuje etykietę. Wybierz kontrastowy textColor.

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

Wyślij scalePercent jako całkowitą wartość procentową, np. 25, a nie 0.25.

Kolor narożników się nie zmienia

Narożniki zawsze mają kolor dotsOptions.color. cornersSquareOptions.color i cornersDotOptions.color nie mają żadnego efektu.

API

Przykładowy obiekt projektu

Style

Ramki

Logo

Sugerowane logo

Własne logo

Rozmiar logo

Aktualizacja projektu

Typowe problemy

Co dalej

Kody QR

Szablony

Pliki

Przegląd projektowania

​Przykładowy obiekt projektu

​Style

​Ramki

​Logo

​Sugerowane logo

​Własne logo

​Rozmiar logo

​Aktualizacja projektu

​Typowe problemy

​Co dalej

Kody QR

Szablony

Pliki

Przegląd projektowania

Przykładowy obiekt projektu

Style

Ramki

Logo

Sugerowane logo

Własne logo

Rozmiar logo

Aktualizacja projektu

Typowe problemy

Co dalej