> ## 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.

# Оформление

> Оформление QR-кодов через API: формы точек и углов, цвета, рамки и логотипы.

> [!NOTE]
>
> GetQR API находится в бета-версии и доступен для отдельных рабочих пространств. До общего релиза детали могут измениться.

Оформите QR-код с помощью необязательных объектов `styles`, `frameOptions` и `logoOptions` при его создании или обновлении. Все поля необязательны, а для пропущенных действуют значения по умолчанию.

Эти три объекта одинаково работают для [QR-кодов](https://docs.getqr.com/ru/api/endpoints/qr-codes.md), [шаблонов](https://docs.getqr.com/ru/api/endpoints/templates.md) и [массового создания](https://docs.getqr.com/ru/api/endpoints/bulk-qr-creations.md). Неизвестные формы, рамки или логотипы отклоняются с `422`.

## Пример объекта дизайна

```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 }
}
```

Передайте его вместе с остальными полями QR-кода:

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

## Стили

Объект `styles` задаёт формы и цвета узора.

| Поле | Значения |
| - | - |
| `dotsOptions.type` | Форма точек узора: `square`, `dots`, `rounded`, `classy`, `classy-rounded`, `extra-rounded` |
| `cornersSquareOptions.type` | Форма угловых квадратов (рамки «глаза»): `square`, `rounded`, `dot`, `classy-rounded` |
| `cornersDotOptions.type` | Форма угловых точек (зрачка «глаза»): `square`, `dot`, `dots`, `rounded`, `classy` |
| `dotsOptions.color` | Цвет переднего плана. По умолчанию `#000000`. |
| `backgroundOptions.color` | Цвет фона. По умолчанию `#ffffff`. |
| `cornersSquareOptions.color`, `cornersDotOptions.color` | Принимаются, но ни на что не влияют: углы всегда используют `dotsOptions.color`. |

* **Цвета.** Только шестнадцатеричные значения: `#RGB` или `#RRGGBB`.
* **Коррекция ошибок.** Всегда `Q`, и это не входной параметр. Передача `styles.qrOptions` возвращает `422`.
* **Branded и AI designs.** Через API их задать нельзя. Передача `styles.logoQrArt` возвращает `422`.
* **Содержимое.** `styles.data` игнорируется. Изображение всегда кодирует содержимое QR-кода.

> [!TIP]
>
> Сохраняйте достаточный контраст между цветом переднего плана и фона: тёмный узор на светлом фоне. QR-коды с низким контрастом могут не сканироваться. См. [Цвета](https://docs.getqr.com/ru/design/colors.md).

## Рамки

Объект `frameOptions` добавляет вокруг QR-кода декоративную рамку с призывом к действию.

| Поле | Описание |
| - | - |
| `id` | Обязательно, если вы передаёте `frameOptions`. Тип рамки из списков ниже. `none` означает «без рамки». |
| `text` | Подпись с призывом к действию, до 12 символов. По умолчанию `Scan me!`. |
| `color` | Цвет рамки, hex. |
| `textColor` | Цвет подписи, hex. Должен отличаться от `color`, если у рамки есть подпись, кроме случаев, когда пара входит во встроенные цветовые пресеты рамки. |
| `borderColor` | Цвет обводки, hex. |
| `fingerPrintColor` | Акцентный цвет иконки рамки, hex. |

> [accordion] Общие рамки
>
> `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` нет подписи.

> [accordion] Рамки по типам QR-кодов
>
> | Тип | Рамки с подписью | Рамки без подписи |
> | - | - | - |
> | 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` |
>
> Любая рамка работает с любым типом QR-кода. Группировка совпадает с панелью управления.

У рамок без подписи нет поля призыва к действию в панели управления, и правило о том, что `textColor` должен отличаться от `color`, к ним не применяется.

## Логотипы

Объект `logoOptions` размещает логотип в центре QR-кода. Вид логотипа задаётся полем `type`.

### Готовый логотип

Установите `type` в `suggested` и выберите `id` из каталога. Чтобы обойтись без логотипа, используйте `logo-none`.

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

> [accordion] Все 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`

### Собственный логотип

**1. Загрузите изображение**

Зарегистрируйте его через [Файлы](https://docs.getqr.com/ru/api/endpoints/files.md) с `"target": "logo"`, затем загрузите файл на полученный `uploadUrl`.

**2. Укажите файл**

Установите `type` в `uploaded`, а `fileId` — в полученный `fileId`. `fileId` обязателен и должен быть ID, который вернул эндпоинт Files.

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

Неизвестный файл, незавершённая загрузка или файл, загруженный для другого target, отклоняются.

### Размер логотипа

`scalePercent` задаёт размер логотипа в процентах от QR-кода. Принимает целое число от 15 до 45. По умолчанию 25. Другие значения, включая доли вроде `0.25`, возвращают `422`.

## Обновление дизайна

* **Частичное обновление.** При [Обновлении QR-кода](https://docs.getqr.com/ru/api/endpoints/qr-codes.md#обновление-qr-кода) объекты `styles`, `frameOptions` и `logoOptions` объединяются с сохранённым дизайном. Частичный объект меняет только то, что в нём указано.
* **Смена логотипа.** Выбор другого логотипа заменяет сохранённый, но сохраняет его `scalePercent`.
* **Шаблоны.** При создании с `templateId` переданные поля накладываются поверх дизайна шаблона. См. [Шаблоны](https://docs.getqr.com/ru/api/endpoints/templates.md).
* **Branded и AI designs.** QR-код с `designKind` `branded` или `ai` создан в панели управления. API не может изменить его изображение, но сохраняет его, когда вы меняете другие поля.
* **Чтение дизайна.** Ответы возвращают сохранённый дизайн в `design` в той же структуре, что и поля запроса, поэтому его можно отправить обратно.

## Частые проблемы

> [accordion] 422 "Error correction is always Q and is not an input"
>
> Уберите `styles.qrOptions` из запроса.

> [accordion] 422 "Frame caption is at most 12 characters"
>
> Сократите `frameOptions.text` до 12 символов или меньше.

> [accordion] 422 "Frame caption color must differ from the frame color"
>
> `textColor` и `color` совпадают у рамки с подписью. Выберите контрастный `textColor`.

> [accordion] 422 "Logo scale is a whole number from 15 to 45"
>
> Передавайте `scalePercent` как целое число процентов, например `25`, а не `0.25`.

> [accordion] Цвет углов не меняется
>
> Углы всегда используют `dotsOptions.color`. `cornersSquareOptions.color` и `cornersDotOptions.color` ни на что не влияют.

## Что дальше

> [card] [QR-коды](https://docs.getqr.com/ru/api/endpoints/qr-codes.md)

> [card] [Шаблоны](https://docs.getqr.com/ru/api/endpoints/templates.md)

> [card] [Файлы](https://docs.getqr.com/ru/api/endpoints/files.md)

> [card] [Обзор оформления](https://docs.getqr.com/ru/design/overview.md)


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