Перейти до основного вмісту
API GetQR перебуває в бета-версії та доступний для окремих робочих просторів. До загального релізу деталі можуть змінитися.
Кожен QR-код має qrType, і тип визначає, що має містити data. У цьому посібнику описано формат кожного типу, робоче тіло запиту й те, що ще можна змінити після друку коду. Приклади — це тіла запитів для Створення QR-коду. Надсилайте їх так:

Усі типи коротко

Як спрацьовує QR-код

Кожен QR-код — це коротке посилання плюс дані. Вміст задають два поля: Правила для всіх типів:
  • Значення за замовчуванням. Під час створення пропущений або порожній link.url набуває значення data, а весь об’єкт link можна не передавати. Якщо надіслано обидва і вони різні, перевагу має link.url. Надсилайте їх однаковими або надсилайте лише data.
  • Що кодує зображення. Для всіх типів, крім wifi, зображення кодує коротке посилання. Тож можна змінити, куди веде надрукований код, а його сканування відстежуються. QR-код WiFi кодує саму мережу: після друку його не можна змінити, а сканування не відстежуються.
  • Схеми. link.url приймає лише http:, https:, wifi:, mailto:, sms: і begin:. Усе інше, зокрема geo:, smsto:, matmsg: і tel:, отримує 422 Invalid destination URL, навіть якщо data таке значення приймає.
  • Порожні дані. Порожнє data пропускає перевірку типу. Для типу з перенаправленням тоді обов’язково має бути заданий link.url, інакше виклик отримає 400 Missing destination URL.
  • Структура. Крім перевірки типу, сервер не валідує дані. Для JSON-типу дані мають лише розбиратися як об’єкт JSON, а vCard має лише починатися з BEGIN:VCARD.
Обмеження, позначені нижче як Конструктор, застосовує редактор у панелі керування. API приймає дані, які їх не дотримуються, але вони можуть дивно відображатися на лендінгу або в редакторі.

Website

qrType: "website". Посібник для панелі керування: QR-код Website.
Тіло запиту
Помилки:
  • 422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".
  • 422 Invalid destination URL

Feedback

qrType: "feedback". Посібник для панелі керування: QR-код Feedback. data — це URL http(s) форми зворотного зв’язку, наприклад Google Form або сторінки з відгуками. Усе інше працює так само, як для Website.
Тіло запиту

Payment

qrType: "payment". Посібник для панелі керування: QR-код Payment. data — це URL оплати в провайдера, наприклад:
Редактор у панелі керування розпізнає такі хости: paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link і payoneer.com. Для PayPal сума — це останній сегмент шляху. Підійде й будь-який інший URL http(s), але редактор не розділить його на провайдера й суму. Усе інше працює так само, як для Website.
Тіло запиту

WhatsApp

qrType: "whatsapp". Посібник для панелі керування: QR-код WhatsApp. data — це посилання wa.me: міжнародний номер цифрами без +, за бажання із заздалегідь заповненим текстом.
Сервер перевіряє лише, що це URL http(s). Панель керування також розпізнає посилання api.whatsapp.com/send. Усе інше працює так само, як для Website.
Тіло запиту

Location

qrType: "location". Посібник для панелі керування: QR-код Location. data — це URL карти. Щоб QR-код можна було редагувати в панелі керування, використовуйте такий формат (query_place_id необов’язковий):
Будь-який інший URL http(s) теж перенаправляє. URI geo: проходить перевірку data, але відхиляється як адреса призначення, тому не використовуйте його. Усе інше працює так само, як для Website.
Тіло запиту
qrType: "app". Посібник для панелі керування: QR-код App Link.
Тіло запиту
Помилки:
  • 422 Invalid URL
  • 400 Missing destination URL

Email

qrType: "email". Посібник для панелі керування: QR-код Email.
Тіло запиту
Помилки:
  • 422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".

SMS

qrType: "sms". Посібник для панелі керування: QR-код SMS.
Тіло запиту
Помилки:
  • 422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".

WiFi

qrType: "wifi". Посібник для панелі керування: QR-код WiFi.
Тіло запиту
Помилки:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
Не змінюйте тип надрукованого QR-коду WiFi. Надруковані коди зберігають стару мережу.

PDF, Image і Video

qrType: "pdf", "image" або "video". Посібники для панелі керування: PDF, Image, Video. Один файл на QR-код: набори PDF і галереї зображень через API недоступні. Див. Не підтримується через API.
Як завантажити файл і отримати його fileId, див. у розділі Файли.

vCard

qrType: "vcard". Посібник для панелі керування: QR-код vCard. Лендінг і редактор читають лише наведені нижче форми рядків. Інші варіанти, як-от TEL;CELL: або EMAIL;TYPE=INTERNET:, зберігаються, але на сторінці не з’являються.
  • N:<last>;<first>;;;: прізвище та ім’я. Конструктор: обидва обов’язкові, до 40 символів.
  • FN:<first> <last>: сторінка його не читає. З нього береться підпис у списку панелі керування.
  • ORG:<company> і TITLE:<role>: компанія та посада. Конструктор: до 40 символів.
  • TEL;TYPE=HOME:, TEL;TYPE=CELL:, TEL;TYPE=WORK:, TEL;TYPE=FAX:: номери телефону, мобільного, робочого й факсу (+ і цифри).
  • EMAIL:<email>: адреса електронної пошти.
  • URL:<url>: вебсайт.
  • NOTE:<text>: опис. Екрануйте \\, \n, \; і \,. Конструктор: до 200 символів.
  • ADR:;;<street>;<city>;<state>;<zip>;<country>: адреса.
  • X-SOCIALPROFILE;TYPE=<platform>:<url> або URL;TYPE=<PLATFORM>:<url>: посилання на соцмережі, по одному рядку на платформу.
  • PHOTO;VALUE=URI:<url>: URL зображення профілю. Має пріоритет над будь-яким ID файлу.
  • X-GETQR-IMAGE-FILEID:<fileId>: зображення профілю (target logo).
  • X-GETQR-PAGE-LOGO-FILEID:<fileId>: логотип сторінки (target logo).
  • X-GETQR-LANDING-THEME:p|<0-4> або X-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: тема лендінгу — або індекс готової теми (від 0 до 4), або власні кольори фону, кнопок і іконок.
Соцмережі: facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Тіло запиту
Помилки:
  • 422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".

Social Media

qrType: "social". Посібник для панелі керування: QR-код Social Media. Поля в data:
Тіло запиту
Помилки:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
qrType: "multilink". Посібник для панелі керування: QR-код Multi-Link. Поля в data такі самі, як у Social Media, але firstName, lastName і summary замінено на: У customItems поле logoFileId необов’язкове: показується резервна іконка. Конструктор: щонайменше одне посилання на соцмережу або один непорожній власний елемент.
Тіло запиту
Помилки:
  • 422 Expected a JSON object describing the multi-link page for qrType "multilink".

Event

qrType: "event". Посібник для панелі керування: QR-код Event. Поля в data:
conference, seminar, workshop, training, webinar, meetup, networking, corporateEvent, productLaunch, tradeShow, jobFair, fundraiser, charity, wedding, engagement, birthday, anniversary, babyShower, graduation, reunion, party, religious, funeralMemorial, ceremony, concert, festival, clubNight, theater, comedy, filmScreening, exhibition, sports, tournament, raceMarathon, fitnessClass, foodDrink, market, openHouse, community, schoolEvent, kids, travelTour
Тіло запиту
Помилки:
  • 422 Expected a JSON object describing the event page for qrType "event".

Файли в QR-кодах

Зареєструйте файл через Файли, завантажте його, а потім передайте його fileId. Використовуйте target, що відповідає призначенню:
  • pdf, image, video. Вміст QR-коду PDF, Image або Video.
  • logo. Зображення профілю, логотипи сторінок, іконки власних посилань і логотипи в центрі.
Файли, які так і не прикріпили до QR-коду, видаляються після пільгового періоду. Помилки fileId, що повертаються під час створення та в PATCH, якщо надіслано fileId: ID файлів усередині даних (fileId, pageLogoFileId, customItems[].logoFileId, рядки X-GETQR-*-FILEID) не перевіряються. Вони відображаються, лише якщо файли завантажено з target logo. QR-код закріплює їх за собою, тому очищення їх не зачіпає.

Зміна типу

Змінити qrType можна через Оновлення QR-коду. Надішліть data, що відповідає новому типу: збережені дані належать старому типу, тому зміну без них буде відхилено. Після оновлення адреса призначення визначається в такому порядку:
  1. vcard, social, multilink, event: завжди розміщена сторінка.
  2. Набір PDF або галерея зображень, створені в панелі керування: їхній лендінг.
  3. pdf, image, video: URL файлу (новий fileId, інакше збережений).
  4. link.url, якщо надіслано.
  5. Змінене data.
  6. Збережений URL.
Що відбувається під час кожної зміни:
  • З pdf, image або video. fileId і будь-який набір або галерея очищаються.
  • На pdf, image або video. Надішліть також fileId, інакше буде повторно використано збережений, а це може бути фото vCard.
  • З app. Назва застосунку, link.ios і link.android очищаються, тож телефони переходять на нову адресу призначення.
  • На wifi. Зображення переходить на сирі дані. Уже надруковані коди й далі містять коротке посилання, яке тепер перенаправляє на URL wifi:.
  • З wifi. Надруковані коди зберігають стару мережу.
  • На vcard, social, multilink або event. Коротке посилання спрямовується на нову розміщену сторінку.
  • З vcard, social, multilink або event. Надішліть нове data. Адреса призначення визначається ним.
Статичні QR-коди, створені в панелі керування, не мають короткого посилання, тому зміна їхнього link.url повертає 422.

Не підтримується через API

Ці можливості панелі керування не входять до API v1. Невідомі поля відкидаються без помилки, тож їх надсилання ні на що не впливає. Набори й галереї, створені в панелі керування, і далі можна читати, призупиняти й видаляти через API, але змінити їхні файли через нього не можна.

Поширені проблеми

link.url використовує схему, на яку коротке посилання не може перенаправити, наприклад geo:, smsto:, matmsg: або tel:. Використовуйте формати з цієї сторінки.
data порожнє, а link.url немає. Для app задайте принаймні одне з link.ios, link.android, link.url або data.
Для типів-посилань збереженим data є коротке посилання. Адресу призначення читайте з url.
Сторінка читає лише поля й форми рядків, наведені для типу. Інші поля зберігаються, але не відображаються.

Що далі

QR-коди

Файли

Оформлення

Правила доступу