Перейти к основному содержанию
GetQR API находится в бета-версии и доступен для отдельных рабочих пространств. До общего релиза детали могут измениться.
Оформите QR-код с помощью необязательных объектов styles, frameOptions и logoOptions при его создании или обновлении. Все поля необязательны, а для пропущенных действуют значения по умолчанию. Эти три объекта одинаково работают для QR-кодов, шаблонов и массового создания. Неизвестные формы, рамки или логотипы отклоняются с 422.

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

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

Стили

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

Рамки

Объект frameOptions добавляет вокруг QR-кода декоративную рамку с призывом к действию.
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 нет подписи.
Любая рамка работает с любым типом QR-кода. Группировка совпадает с панелью управления.
У рамок без подписи нет поля призыва к действию в панели управления, и правило о том, что textColor должен отличаться от color, к ним не применяется.

Логотипы

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

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

Установите type в suggested и выберите id из каталога. Чтобы обойтись без логотипа, используйте logo-none.
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

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

Зарегистрируйте его через Файлы с "target": "logo", затем загрузите файл на полученный uploadUrl.
2

Укажите файл

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

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

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

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

  • Частичное обновление. При Обновлении QR-кода объекты styles, frameOptions и logoOptions объединяются с сохранённым дизайном. Частичный объект меняет только то, что в нём указано.
  • Смена логотипа. Выбор другого логотипа заменяет сохранённый, но сохраняет его scalePercent.
  • Шаблоны. При создании с templateId переданные поля накладываются поверх дизайна шаблона. См. Шаблоны.
  • Branded и AI designs. QR-код с designKind branded или ai создан в панели управления. API не может изменить его изображение, но сохраняет его, когда вы меняете другие поля.
  • Чтение дизайна. Ответы возвращают сохранённый дизайн в design в той же структуре, что и поля запроса, поэтому его можно отправить обратно.

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

Уберите styles.qrOptions из запроса.
Сократите frameOptions.text до 12 символов или меньше.
textColor и color совпадают у рамки с подписью. Выберите контрастный textColor.
Передавайте scalePercent как целое число процентов, например 25, а не 0.25.
Углы всегда используют dotsOptions.color. cornersSquareOptions.color и cornersDotOptions.color ни на что не влияют.

Что дальше

QR-коды

Шаблоны

Файлы

Обзор оформления