Посібник із API QR-кодів для розробників

API-ключ

Ключ API для вашого облікового запису можна створити на сторінці облікового запису. Ключ API може бути включений у запити як параметр URL, наприклад: https://api.genqrcode.com/public/generate?apikey=YOUR_API_KEY, або в заголовку `GenQRCode-apikey`. У решті цього посібника ми будемо припускати використання заголовка, оскільки це безпечніший варіант, але обидва методи можуть використовуватися взаємозамінно. Ключ API слід вважати секретним, і ви не повинні ділитися ним з ким-небудь.

Обмеження швидкості запитів

Обмеження швидкості запитів запроваджене для забезпечення справедливого використання API. Безкоштовний тарифний план включає 180 токенів на годину. Створення звичайного QR-коду коштує 1 токен, з максимальною межею в 180 токенів на годину, що дорівнює 1 QR-коду кожні 20 секунд. Крім того, швидкі ендпоінти коштують 1/50 токена, що дозволяє генерувати 2,5 QR-коди в секунду. Швидкі ендпоінти рекомендуються для випадків, коли налаштування QR-коду не потрібне. Якщо ліміт токенів перевищено, повертається статус-код 429, що вказує на обмеження швидкості запитів.

Використання кількох облікових записів для обходу цих обмежень заборонено. Якщо потрібні вищі ліміти, зв’яжіться з нами для обговорення тарифів.

Бібліотеки

Java Library

API статичних QR-кодів

Приклад текстового QR-коду

URL	https://api.genqrcode.com/public/generate
Метод запиту	POST
Заголовки	GenQRCode-apikey: API_KEY
Тіло запиту	{ "type": 0, "text": "https://genqrcode.com" }
Відповідь

Приклад Wi-Fi QR-коду

URL	https://api.genqrcode.com/public/generate
Метод запиту	POST
Заголовки	GenQRCode-apikey: API_KEY
Тіло запиту	{ "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" }
Відповідь

Приклад QR-коду з кольором

URL	https://api.genqrcode.com/public/generate
Метод запиту	POST
Заголовки	GenQRCode-apikey: API_KEY
Тіло запиту	{ "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" }
Відповідь

Приклад QR-коду з кольоровим візерунком

URL	https://api.genqrcode.com/public/generate
Метод запиту	POST
Заголовки	GenQRCode-apikey: API_KEY
Тіло запиту	{ "type": 0, "text": "https://genqrcode.com", "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d", "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6" }
Відповідь

Параметри рамки, форми та логотипу

Тут описані всі параметри рамки, форми та логотипу та способи їх використання.

Параметр	Тип	Значення за замовчуванням	Опис
style	Int	0	Стиль квадратів QR-коду. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
inner_eye_style	Int	0	Стиль внутрішніх очей QR-коду. 0 1 2 3 4 5 6 7
outer_eye_style	Int	0	Стиль зовнішніх очей QR-коду. 0 1 2 3 4 5 6
frame_style	Int	0	Стиль рамки навколо QR-коду. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
frame_text	String	SCAN ME	Текст усередині рамки. Щоб цей текст відображався, необхідно налаштувати рамку з текстом.
logo	String		Логотип для використання всередині QR-коду. youtube wifi google-maps facebook spotify threads zoom instagram linkedin genqrcode google-drive airbnb skype snapchat twitter x-twitter reddit
logo_remove_background	Boolean	false	Чи слід видаляти фон позаду логотипу.

Приклад QR-коду з логотипом і формою

URL	https://api.genqrcode.com/public/generate
Метод запиту	POST
Заголовки	GenQRCode-apikey: API_KEY
Тіло запиту	{ "type": 0, "text": "https://x.com/genqrcode", "style": 22, "inner_eye_style": 1, "outer_eye_style": 4, "frame": 10, "frame_text": "My X Page", "logo": "x-twitter", "logo_remove_background":true }
Відповідь

API швидкого QR-коду

API швидкого QR-коду витрачає лише 1/50 токена від звичайного API. QR-коди оптимізовані для швидкості та розміру завантаження. Він підтримує всі типи QR-кодів, але має лише обмежену кількість параметрів налаштування.

Приклад швидкого текстового QR-коду

URL	https://api.genqrcode.com/public/fastgenerate
Метод запиту	POST
Заголовки	GenQRCode-apikey: API_KEY
Тіло запиту	{ "imageformat": "png", "type": 0, "text": "https://genqrcode.com" }
Відповідь

API швидкого пакетного створення QR-кодів

{
  "QR Code 1": {
    "text": "https://genqrcode.com",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 2": {
    "text": "https://genqrcode.com/dynamicview",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 3": {
    "text": "https://genqrcode.com/pricing",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  }
}