GetQR API находится в бета-версии и доступен для отдельных рабочих пространств. До общего релиза детали могут измениться.
styles, frameOptions и logoOptions при его создании или обновлении. Все поля необязательны, а для пропущенных действуют значения по умолчанию.
Эти три объекта одинаково работают для QR-кодов, шаблонов и массового создания. Неизвестные формы, рамки или логотипы отклоняются с 422.
Пример объекта дизайна
Стили
Объектstyles задаёт формы и цвета узора.
- Цвета. Только шестнадцатеричные значения:
#RGBили#RRGGBB. - Коррекция ошибок. Всегда
Q, и это не входной параметр. Передачаstyles.qrOptionsвозвращает422. - Branded и AI designs. Через API их задать нельзя. Передача
styles.logoQrArtвозвращает422. - Содержимое.
styles.dataигнорируется. Изображение всегда кодирует содержимое 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-кодов
Рамки по типам QR-кодов
Любая рамка работает с любым типом QR-кода. Группировка совпадает с панелью управления.
textColor должен отличаться от color, к ним не применяется.
Логотипы
ОбъектlogoOptions размещает логотип в центре QR-кода. Вид логотипа задаётся полем type.
Готовый логотип
Установитеtype в suggested и выберите id из каталога. Чтобы обойтись без логотипа, используйте logo-none.
Все ID готовых логотипов
Все 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
Загрузите изображение
Зарегистрируйте его через Файлы с
"target": "logo", затем загрузите файл на полученный uploadUrl.2
Укажите файл
Установите
type в uploaded, а fileId — в полученный fileId. fileId обязателен и должен быть ID, который вернул эндпоинт Files.Размер логотипа
scalePercent задаёт размер логотипа в процентах от QR-кода. Принимает целое число от 15 до 45. По умолчанию 25. Другие значения, включая доли вроде 0.25, возвращают 422.
Обновление дизайна
- Частичное обновление. При Обновлении QR-кода объекты
styles,frameOptionsиlogoOptionsобъединяются с сохранённым дизайном. Частичный объект меняет только то, что в нём указано. - Смена логотипа. Выбор другого логотипа заменяет сохранённый, но сохраняет его
scalePercent. - Шаблоны. При создании с
templateIdпереданные поля накладываются поверх дизайна шаблона. См. Шаблоны. - Branded и AI designs. QR-код с
designKindbrandedилиaiсоздан в панели управления. API не может изменить его изображение, но сохраняет его, когда вы меняете другие поля. - Чтение дизайна. Ответы возвращают сохранённый дизайн в
designв той же структуре, что и поля запроса, поэтому его можно отправить обратно.
Частые проблемы
422 "Error correction is always Q and is not an input"
422 "Error correction is always Q and is not an input"
Уберите
styles.qrOptions из запроса.422 "Frame caption is at most 12 characters"
422 "Frame caption is at most 12 characters"
Сократите
frameOptions.text до 12 символов или меньше.422 "Frame caption color must differ from the frame color"
422 "Frame caption color must differ from the frame color"
textColor и color совпадают у рамки с подписью. Выберите контрастный textColor.422 "Logo scale is a whole number from 15 to 45"
422 "Logo scale is a whole number from 15 to 45"
Передавайте
scalePercent как целое число процентов, например 25, а не 0.25.Цвет углов не меняется
Цвет углов не меняется
Углы всегда используют
dotsOptions.color. cornersSquareOptions.color и cornersDotOptions.color ни на что не влияют.