> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getqr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Mukauttaminen

> Muotoile QR-koodeja API:n kautta: pisteiden ja kulmien muodot, värit, kehykset ja logot.

> [!NOTE]
>
> GetQR API on beetavaiheessa, ja se on käytettävissä valituissa työtiloissa. Yksityiskohdat voivat muuttua ennen yleistä julkaisua.

Muotoile QR-koodi valinnaisilla objekteilla `styles`, `frameOptions` ja `logoOptions`, kun luot tai päivität sen. Kaikki kentät ovat valinnaisia, ja pois jättämäsi kentät saavat oletusarvot.

Samat kolme objektia toimivat [QR-koodeissa](https://docs.getqr.com/fi/api/endpoints/qr-codes.md), [malleissa](https://docs.getqr.com/fi/api/endpoints/templates.md) ja [joukkoluonneissa](https://docs.getqr.com/fi/api/endpoints/bulk-qr-creations.md). Tuntemattomat muodot, kehykset tai logot hylätään koodilla `422`.

## Esimerkki ulkoasuobjektista

```json theme={null}
{
  "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 }
}
```

Lähetä se muun QR-koodin datan mukana:

```bash theme={null}
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" }
  }'
```

## Tyylit

`styles`-objekti määrittää kuvion muodot ja värit.

| Kenttä | Arvot |
| - | - |
| `dotsOptions.type` | Rungon pisteiden muoto: `square`, `dots`, `rounded`, `classy`, `classy-rounded`, `extra-rounded` |
| `cornersSquareOptions.type` | Kulmaneliön (silmäkehyksen) muoto: `square`, `rounded`, `dot`, `classy-rounded` |
| `cornersDotOptions.type` | Kulmapisteen (silmäterän) muoto: `square`, `dot`, `dots`, `rounded`, `classy` |
| `dotsOptions.color` | Edustaväri. Oletus `#000000`. |
| `backgroundOptions.color` | Taustaväri. Oletus `#ffffff`. |
| `cornersSquareOptions.color`, `cornersDotOptions.color` | Hyväksytään, mutta niillä ei ole vaikutusta: kulmat käyttävät aina arvoa `dotsOptions.color`. |

* **Värit.** Vain heksadesimaaliarvot: `#RGB` tai `#RRGGBB`.
* **Virheenkorjaus.** Aina `Q`, eikä sitä voi asettaa. `styles.qrOptions`-kentän lähettäminen palauttaa `422`.
* **Brändätyt ja tekoälyllä luodut ulkoasut.** Niitä ei voi asettaa API:n kautta. `styles.logoQrArt`-kentän lähettäminen palauttaa `422`.
* **Sisältö.** `styles.data` ohitetaan. Kuva koodaa aina QR-koodin sisällön.

> [!TIP]
>
> Pidä edusta- ja taustavärin välillä riittävä kontrasti: tumma edustaväri vaalealla taustalla. Matalan kontrastin koodit eivät välttämättä skannaudu. Katso [Värit](https://docs.getqr.com/fi/design/colors.md).

## Kehykset

`frameOptions`-objekti lisää QR-koodin ympärille koristeellisen kehyksen ja toimintakehotteen.

| Kenttä | Kuvaus |
| - | - |
| `id` | Pakollinen, kun lähetät `frameOptions`-objektin. Kehyksen tyyppi alla olevista luetteloista. `none` tarkoittaa, ettei kehystä ole. |
| `text` | Toimintakehotteen teksti, enintään 12 merkkiä. Oletus `Scan me!`. |
| `color` | Kehyksen väri, heksa. |
| `textColor` | Tekstin väri, heksa. Sen on erottava arvosta `color`, kun kehys näyttää tekstin, ellei pari ole jokin kehyksen valmiista väriyhdistelmistä. |
| `borderColor` | Reunuksen väri, heksa. |
| `fingerPrintColor` | Kehyksen kuvakkeen korostusväri, heksa. |

> [accordion] Yleiset kehykset
>
> `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`, `clipboard`
>
> `card-hor` ei näytä tekstiä.

> [accordion] Kehykset QR-koodityypeittäin
>
> | Tyyppi | Kehykset, joissa on teksti | Kehykset ilman tekstiä |
> | - | - | - |
> | 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` |
>
> Mikä tahansa kehys toimii minkä tahansa QR-koodityypin kanssa. Ryhmittely vastaa hallintapaneelia.

Kehyksissä ilman tekstiä ei ole hallintapaneelissa toimintakehotteen kenttää, eikä sääntö, jonka mukaan `textColor`-arvon on erottava arvosta `color`, koske niitä.

## Logot

`logoOptions`-objekti sijoittaa logon QR-koodin keskelle. Valitse logon laji kentällä `type`.

### Ehdotettu logo

Aseta `type`-arvoksi `suggested` ja valitse `id` luettelosta. Käytä arvoa `logo-none`, jos et halua logoa.

```json theme={null}
{ "logoOptions": { "type": "suggested", "id": "logo-instagram", "scalePercent": 25 } }
```

> [accordion] Kaikki ehdotettujen logojen tunnukset
>
> `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`

### Oma logo

**1. Lataa kuva**

Rekisteröi se [Tiedostot](https://docs.getqr.com/fi/api/endpoints/files.md)-päätepisteellä käyttäen arvoa `"target": "logo"` ja lataa tiedosto sitten palautettuun osoitteeseen `uploadUrl`.

**2. Viittaa tiedostoon**

Aseta `type`-arvoksi `uploaded` ja `fileId`-arvoksi palautettu `fileId`. `fileId` on pakollinen, ja sen on oltava Files-päätepisteen palauttama tunnus.

```json theme={null}
{ "logoOptions": { "type": "uploaded", "fileId": "file_7bQ2xR9mKp", "scalePercent": 35 } }
```

Tuntematon tiedosto, keskeneräinen lataus tai toiselle targetille ladattu tiedosto hylätään.

### Logon koko

`scalePercent` määrittää logon koon prosentteina QR-koodista. Se ottaa kokonaisluvun väliltä 15–45. Oletus on 25. Muut arvot, myös suhdeluvut kuten `0.25`, palauttavat `422`.

## Ulkoasun päivittäminen

* **Osittaiset päivitykset.** [QR-koodin päivityksessä](https://docs.getqr.com/fi/api/endpoints/qr-codes.md#päivitä-qr-koodi) objektit `styles`, `frameOptions` ja `logoOptions` yhdistetään tallennettuun ulkoasuun. Osittainen objekti muuttaa vain siinä mainitut asiat.
* **Logon vaihtaminen.** Toisen logon valinta korvaa tallennetun logon mutta säilyttää sen `scalePercent`-arvon.
* **Mallit.** Kun luonnissa annetaan `templateId`, lähettämäsi kentät yhdistetään mallin ulkoasun päälle. Katso [Mallit](https://docs.getqr.com/fi/api/endpoints/templates.md).
* **Brändätyt ja tekoälyllä luodut ulkoasut.** QR-koodi, jonka `designKind` on `branded` tai `ai`, on tehty hallintapaneelissa. API ei voi muokata sen kuvaa, mutta säilyttää sen, kun muutat muita kenttiä.
* **Ulkoasun lukeminen.** Vastaukset palauttavat tallennetun ulkoasun kentässä `design` samassa muodossa kuin pyynnön kentät, joten voit lähettää sen takaisin.

## Yleisiä ongelmia

> [accordion] 422 "Error correction is always Q and is not an input"
>
> Poista `styles.qrOptions` pyynnöstä.

> [accordion] 422 "Frame caption is at most 12 characters"
>
> Lyhennä `frameOptions.text` enintään 12 merkkiin.

> [accordion] 422 "Frame caption color must differ from the frame color"
>
> `textColor` ja `color` ovat samat kehyksessä, joka näyttää tekstin. Valitse kontrastinen `textColor`.

> [accordion] 422 "Logo scale is a whole number from 15 to 45"
>
> Lähetä `scalePercent` kokonaisena prosenttilukuna, esimerkiksi `25`, ei `0.25`.

> [accordion] Kulmien väri ei muutu
>
> Kulmat käyttävät aina arvoa `dotsOptions.color`. `cornersSquareOptions.color` ja `cornersDotOptions.color` eivät vaikuta mihinkään.

## Mitä seuraavaksi

> [card] [QR-koodit](https://docs.getqr.com/fi/api/endpoints/qr-codes.md)

> [card] [Mallit](https://docs.getqr.com/fi/api/endpoints/templates.md)

> [card] [Tiedostot](https://docs.getqr.com/fi/api/endpoints/files.md)

> [card] [Suunnittelun yleiskatsaus](https://docs.getqr.com/fi/design/overview.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.