Руководство по 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 секунд. Кроме того, быстрые конечные точки (fast call endpoints) стоят 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" }
Ответ

Пример QR-кода Wi-Fi

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