Pielāgošana

GetQR API ir beta versijā un pieejams atlasītām darbvietām. Līdz vispārējai izlaišanai detaļas var mainīties.

Noformējiet QR kodu ar neobligātajiem objektiem styles, frameOptions un logoOptions, kad to izveidojat vai atjauninat. Visi lauki nav obligāti, un visam, ko izlaižat, tiek piemērotas noklusējuma vērtības. Tie paši trīs objekti darbojas QR kodiem, veidnēm un lielapjoma izveidei. Nezināmas formas, rāmji vai logotipi tiek noraidīti ar 422.

Dizaina objekta piemērs

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

Sūtiet to kopā ar pārējiem QR koda laukiem:

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

Stili

Objekts styles nosaka raksta formas un krāsas.

Lauks	Vērtības
`dotsOptions.type`	Ķermeņa punktu forma: `square`, `dots`, `rounded`, `classy`, `classy-rounded`, `extra-rounded`
`cornersSquareOptions.type`	Stūra kvadrāta (acs rāmja) forma: `square`, `rounded`, `dot`, `classy-rounded`
`cornersDotOptions.type`	Stūra punkta (acs zīlītes) forma: `square`, `dot`, `dots`, `rounded`, `classy`
`dotsOptions.color`	Priekšplāna krāsa. Noklusējums: `#000000`.
`backgroundOptions.color`	Fona krāsa. Noklusējums: `#ffffff`.
`cornersSquareOptions.color`, `cornersDotOptions.color`	Tiek pieņemti, bet neietekmē neko: stūri vienmēr izmanto `dotsOptions.color`.

Krāsas. Tikai heksadecimālas vērtības: #RGB vai #RRGGBB.
Kļūdu labošana. Vienmēr Q, un to nevar norādīt. Nosūtot styles.qrOptions, tiek atgriezts 422.
Branded un AI dizaini. Tos nevar iestatīt ar API. Nosūtot styles.logoQrArt, tiek atgriezts 422.
Saturs. styles.data tiek ignorēts. Attēls vienmēr kodē QR koda saturu.

Nodrošiniet pietiekamu kontrastu starp priekšplāna un fona krāsām: tumšs priekšplāns uz gaiša fona. Kodi ar zemu kontrastu var netikt noskenēti. Skatiet Krāsas.

Rāmji

Objekts frameOptions pievieno ap QR kodu dekoratīvu rāmi ar aicinājumu rīkoties.

Lauks	Apraksts
`id`	Obligāts, ja sūtāt `frameOptions`. Rāmja veids no tālāk dotajiem sarakstiem. `none` nozīmē bez rāmja.
`text`	Aicinājuma rīkoties uzraksts, līdz 12 rakstzīmēm. Noklusējums: `Scan me!`.
`color`	Rāmja krāsa, hex.
`textColor`	Uzraksta krāsa, hex. Ja rāmis rāda uzrakstu, tai jāatšķiras no `color`, ja vien pāris nav viena no rāmja iebūvētajām krāsu sagatavēm.
`borderColor`	Apmales krāsa, hex.
`fingerPrintColor`	Rāmja ikonas akcenta krāsa, hex.

Vispārīgie rāmji

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 nerāda uzrakstu.

Rāmji pēc QR koda veida

Veids	Rāmji ar uzrakstu	Rāmji bez uzraksta
Lietotnes saite	`app-3`	`app-1`, `app-2`
vCard	`contact-1`, `contact-5`	`contact-2`, `contact-3`, `contact-4`
E-pasts	`email-1`	`email-2`, `email-3`, `email-4`, `email-5`
Atsauksmes	—	`feedback-1`, `feedback-2`, `feedback-3`, `feedback-4`, `feedback-5`
Image	—	`image-1`, `image-2`, `image-3`, `image-4`, `image-5`, `image-6`
Atrašanās vieta	`location-3`	`location-1`, `location-2`, `location-4`, `location-5`, `location-6`
Multi-Link	`multilink-3`	`multilink-1`, `multilink-2`
Maksājums	—	`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`

Jebkurš rāmis darbojas ar jebkuru QR koda veidu. Grupējums atbilst informācijas panelim.

Rāmjiem bez uzraksta informācijas panelī nav aicinājuma rīkoties lauka, un noteikums, ka textColor jāatšķiras no color, uz tiem neattiecas.

Logotipi

Objekts logoOptions novieto logotipu QR koda centrā. Iestatiet type, lai izvēlētos logotipa veidu.

Ieteiktais logotips

Iestatiet type uz suggested un izvēlieties id no kataloga. Ja logotips nav vajadzīgs, izmantojiet logo-none.

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

Visi ieteikto logotipu ID

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

Jūsu logotips

Augšupielādējiet attēlu

Reģistrējiet to ar Faili, izmantojot "target": "logo", pēc tam augšupielādējiet failu uz atgriezto uploadUrl.

Norādiet failu

Iestatiet type uz uploaded un fileId uz atgriezto fileId. fileId ir obligāts, un tam jābūt ID, ko atgriezis galapunkts Files.

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

Nezināms fails, nepabeigta augšupielāde vai fails, kas augšupielādēts citam target, tiek noraidīts.

Logotipa izmērs

scalePercent iestata logotipa izmēru procentos no QR koda. Vērtība ir vesels skaitlis no 15 līdz 45. Noklusējums ir 25. Citas vērtības, ieskaitot daļskaitļus, piemēram, 0.25, saņem 422.

Dizaina atjaunināšana

Daļēji atjauninājumi. QR koda atjaunināšanā styles, frameOptions un logoOptions tiek apvienoti ar saglabāto dizainu. Daļējs objekts maina tikai to, ko tas norāda.
Logotipa maiņa. Izvēloties citu logotipu, saglabātais tiek aizstāts, bet tā scalePercent paliek.
Veidnes. Ar templateId izveides brīdī nosūtītie lauki tiek apvienoti virs veidnes dizaina. Skatiet Veidnes.
Branded un AI dizaini. QR kods ar designKind branded vai ai ir izveidots informācijas panelī. API nevar rediģēt tā attēlu, bet saglabā to, kad maināt citus laukus.
Dizaina nolasīšana. Atbildes atgriež saglabāto dizainu laukā design tādā pašā formā kā pieprasījuma lauki, tāpēc varat to nosūtīt atpakaļ.

Biežākās problēmas

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

Noņemiet styles.qrOptions no pieprasījuma.

422 "Frame caption is at most 12 characters"

Saīsiniet frameOptions.text līdz 12 rakstzīmēm vai mazāk.

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

textColor un color ir vienādi rāmim, kas rāda uzrakstu. Izvēlieties kontrastējošu textColor.

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

Sūtiet scalePercent kā veselu procentu skaitu, piemēram, 25, nevis 0.25.

Stūru krāsa nemainās

Stūri vienmēr izmanto dotsOptions.color. cornersSquareOptions.color un cornersDotOptions.color neko neietekmē.

API

Dizaina objekta piemērs

Stili

Rāmji

Logotipi

Ieteiktais logotips

Jūsu logotips

Logotipa izmērs

Dizaina atjaunināšana

Biežākās problēmas

Kas tālāk

QR kodi

Veidnes

Faili

Dizaina pārskats

​Dizaina objekta piemērs

​Stili

​Rāmji

​Logotipi

​Ieteiktais logotips

​Jūsu logotips

​Logotipa izmērs

​Dizaina atjaunināšana

​Biežākās problēmas

​Kas tālāk

QR kodi

Veidnes

Faili

Dizaina pārskats

Dizaina objekta piemērs

Stili

Rāmji

Logotipi

Ieteiktais logotips

Jūsu logotips

Logotipa izmērs

Dizaina atjaunināšana

Biežākās problēmas

Kas tālāk