STQR API Пригласительный билет/купон на скидку
Информация для создания и изменения QR-кодов
Динамический QR-код позволяющий получить рекламный/скидочный купон или, пригласительный билет
Доступные команды:
test
create
read
update
delete
check
Перечень полей данных приведен в таблице:
| Имя | Тип данных, значение | Значение по умолчанию | Описание |
|---|---|---|---|
| Системные параметры | |||
token |
Строка, константа Значение |
Обязательный. Ключ авторизации. Для активации ключа перейдите в раздел Профиль и заполните пользовательскую анкету. | |
c |
Число, константа44
|
Обязательный. Класс создаваемого кода. Только для команды create |
|
t |
Число, константа1 - для статических QR-кодов2 - для динамических QR-кодов
|
Обязательный. Тип QR кода. Используется для всех команд, где идет работа с QR-кодами. | |
id |
Число | Числовой уникальный идентификатор в БД STQR. Поле id используется для команд read, update, delete. Получить можно из ответа при создании или редактировании записи. | |
uid |
Строка | UID - уникальный дентификатор динамического QR-кода в STQR.RU. Используется для доступа мобильной странице динамического QR-кода по http, например, https://stqr.ru/{uid} | |
tuid |
Строка | TUID - текстовый идентификатор динамического QR-кода в STQR.RU. Используется для доступа к QR-объявлению по http, например, https://stqr.ru/-/{tuid} | |
guid |
Строка | GUID - уникальный идентификатор записи внешней системы. Предназначен для обеспечения уникальности данных в БД STQR и внешней системы. | |
name |
Строка | Обязательный. Название QR-кода в личном кабинете STQR.RU. С данным наименованием статический или динамический QR-код будет отображаться в разделах личного кабинета. | |
lang |
Строка Значения: ru, en, de, cn и др.
|
"" |
Язык динамического QR-кода. Если не указан, то будет использоваться русский язык. |
group |
Строка | "" |
Идентификатор группы, применяется для группировки динамических QR-кодов по некоторым признакам, например для отображения мультиязычных визитных карточек. |
| Пользовательские поля данных для формирования QR-кода | |||
title |
Строка |
|
Заголовок, наименование рекламной кампании (обязательно) |
category |
Строка Выпадающий список:
|
|
Категория, тип |
description |
HTML |
|
Общее описание, условия проведения и сроки |
promoimg_lg |
Строка, ссылка на изображение |
|
Изображение для широких экранов |
promoimg_sm |
Строка, ссылка на изображение |
|
Изображение для смартфонов |
url |
Строка Формат: http://your.site.ru или https://your.site.ru
|
|
Ссылка на сайт с описанием рекламной кампании |
|
|
||
limittype |
Строка Выпадающий список:
|
|
Категория, тип |
count_max |
Число |
|
Максимальное количество купонов |
date_begin |
Строка Значения: 2019-12-31
|
|
Дата начала действия акции |
date_end |
Строка Значения: 2019-12-31
|
|
Дата окончания действия акции |
|
|
||
buttontext |
Строка |
|
Надпись на кнопке получения купона |
buttontext_color |
Строка Формат: #112233 или #123
|
|
Цвет текста кнопки |
buttontext_bgcolor |
Строка Формат: #112233 или #123
|
|
Цвет фона кнопки |
|
|
||
is_form_hide |
Число Значения: 0, 1
|
|
Не использовать форму с контактными данными для получения купона |
is_email_required |
Число Значения: 0, 1
|
|
Требовать заполнение поля email |
is_phone_required |
Число Значения: 0, 1
|
|
Требовать заполнение поля телефон |
is_select1_required |
Число Значения: 0, 1
|
|
Требовать заполнение поля Список 1 |
select1 |
Строка |
|
Название Списка 1 |
select1_data |
Текст |
|
Данные для Списка 1 |
select1_comment |
Строка |
|
Комментарий к Списку 1 |
is_select2_required |
Число Значения: 0, 1
|
|
Требовать заполнение поля Список 2 |
select2 |
Строка |
|
Название Списка 2 |
select2_data |
Текст |
|
Данные для Списка 2 |
select2_comment |
Строка |
|
Комментарий к Списку 2 |
|
|
||
success_text |
HTML |
|
Показывать следующий текст (опционально) |
success_img |
Строка, ссылка на изображение |
|
Показывать изображение (опционально) |
link_success |
Строка |
|
Показывать кнопку-ссылку с текстом (опционально) |
url_success |
Строка Формат: http://your.site.ru или https://your.site.ru
|
|
URL кнопки-ссылки |
|
|
||
expired_text |
HTML |
|
Показывать следующий текст |
expired_img |
Строка, ссылка на изображение |
|
Показывать изображение (опционально) |
|
|
||
limit_text |
HTML |
|
Показывать следующий текст |
limit_img |
Строка, ссылка на изображение |
|
Показывать изображение (опционально) |
|
|
||
couponpass |
Число Значения: 0, 1
|
|
Разрешать погашение купона по паролю (опционально) |
is_email_unique |
Число Значения: 0, 1
|
|
Проверять email на уникальность при создании купона (опционально) |
is_phone_unique |
Число Значения: 0, 1
|
|
Проверять телефон на уникальность при создании купона (опционально) |
|
|
||
is_couponinfo |
Строка Выпадающий список:
|
|
Показывать дополнительную информацию в виде |
couponinfo_buttontext |
Строка |
|
Надпись на кнопке или текст ссылки |
couponinfo_link |
Строка |
|
Ссылка для перехода при нажатии |
couponinfo_text |
HTML |
|
Текст |
|
|
||
couponemail_img |
Строка, ссылка на изображение |
|
Изображение логотипа (опционально) |
couponemail_text (опционально) |
HTML |
|
Текст |
| Перечень параметров изображения QR-кода | |||
|
""
|
||
level |
Список
Значения: L
- L - допустимо 7% повреждений
;
M
- M - допустимо 15% повреждений
;
Q
- Q -допустимо 25% повреждений
;
H
- H - допустимо 30% повреждений
;
|
"L"
|
Уровень коррекции ошибок
L - низкий, M - средний, Q - выше среднего, H - высокий |
size |
Список
Значения: 1
;
2
;
3
;
4
;
5
;
6
;
7
;
8
;
9
;
10
;
15
;
20
;
30
;
40
;
50
;
60
;
|
"10"
|
Размер элемента, px
Определяет размер элемента QR-кода в пикселях. |
frame |
Список
Значения: 0
;
1
;
2
;
3
;
4
;
5
;
6
;
7
;
8
;
9
;
10
;
|
"5"
|
Размер защитного поля QR кода
Определяет размер защитного поля вокруг QR-кода. Задается в количестве точек кода. |
sizesvg |
Строка | "300"
|
Размер SVG изображения
Определяет ширину изображения в единицах измерения. Высота изображения определяется автоматически. |
sizesvgdims |
Список
Значения: px
- Пиксели
;
pt
- Пункты
;
cm
- Сантиметры
;
mm
- Миллиметры
;
in
- Дюймы
;
|
"0"
|
Единицы измерения SVG |
sizejpg |
Строка | "300"
|
Размер изображения JPG, px
Определяет ширину JPG изображения в пикселях (px). Высота изображения определяется автоматически. |
sizepng |
Строка | "300"
|
Размер изображения PNG, px
Определяет ширину PNG изображения в пикселях (px). Высота изображения определяется автоматически. |
colortype |
Список
Значения: 1
- Градиент
;
|
"0"
|
Заполнение элементов
Градиент доступен только для растровых форматов изображения PNG и JPG |
gradientcolor1 |
Строка | "#000000"
|
Цвет градиента 1 |
gradientcolor2 |
Строка | "#000000"
|
Цвет градиента 2 |
gradienttype |
Список
Значения: top-bottom
- Линейный сверху-вниз
;
bottom-top
- Линейный снизу-вверх
;
left-right
- Линейный слева-направо
;
right-left
- Линейный справа-налево
;
from-center
- Радиальный от центра
;
to-center
- Радиальный к центру
;
|
"top-bottom"
|
Направление |
color |
Строка | "#000000"
|
Цвет элементов QR-кода
По умолчанию - черный (#000000) |
bgtransparent |
Список
Значения: -1
- Однородное
;
1
- Прозрачный фон
;
|
"-1"
|
Фоновое заполнение
Доступен только для формата PNG и SVG |
color2 |
Строка | "#FFFFFF"
|
Цвет фона
По умолчанию - белый (#FFFFFF) |
qrdesign |
Строка
Значения: rectangle
- Квадраты
;
rounded_10
- Загругленный 10%
;
rounded_30
- Загругленный 30%
;
rounded_50
- Закругленный 50%
;
circle
- Кружки
;
rombus
- Ромбы
;
|
""
|
Узор QR-кода
По умолчанию - квадраты |
qrlogo |
Число, идентификатор
Системные: 
103
102
101
100
99
98
97
96
95
94
93
92
91
356
357
358
359
375
376
377
437
436
435
431
433
432
2756
2755
Пользовательские: 
12
13
14
15
16
17
18
19
20
21
27
28
29
30
31
32
33
34
35
36
37
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
56
57
58
59
60
61
62
63
64
65
66
91
92
93
94
95
96
97
98
99
100
101
102
103
106
107
108
356
357
358
359
375
376
377
431
432
433
435
436
437
924
925
926
927
981
982
983
984
1183
1184
1185
1186
1681
1682
1683
1684
1685
1704
2755
2756
|
""
|
Идентификатор логотипа, который может быть размещен в центре QR-кода. Для добавления пользовательского логотипа перейдите в раздел Логотипы и загрузите ваш логотип. |
logosize |
Список
Значения: 5
;
6
;
7
;
8
;
10
;
11
;
12
;
13
;
14
;
15
;
20
;
25
;
|
"18"
|
Размер логотипа, %
Определяет размер логотипа в % от размера QR-кода. Рекомендуем устанавливать размер не менее 10 и не более 15 %. |
logomargin |
Список
Значения: 1
;
2
;
3
;
4
;
5
;
6
;
7
;
8
;
9
;
10
;
15
;
20
;
30
;
40
;
50
;
|
"5"
|
Размер полей логотипа, %
Определяет размер полей для логотипа в % от размера логотипа |
logoframe |
Число
Значения: 0
- нет
;
1
- да
;
|
"0"
|
Рамка логотипа |
logoframetype |
Список
Значения: 0
- круглая
;
1
- прямоугольная
;
|
"0"
|
Форма рамки |
logoframesize |
Список
Значения: 0
;
1
;
2
;
3
;
4
;
5
;
6
;
7
;
8
;
9
;
10
;
15
;
20
;
30
;
|
"2"
|
Толщина рамки, px |
logoframecolor |
Строка | "#000000"
|
Цвет рамки
По умолчанию - черный (#000000) |
logobgtype |
Число
Значения: 0
- нет
;
1
- да
;
|
"0"
|
Изменить цвет фона логотипа |
logobgcolor |
Строка | "#FFFFFF"
|
Цвет фона логотипа
По умолчанию - белый (#FFFFFF) |
logobgclear |
Число
Значения: 0
- нет
;
1
- да
;
|
"0"
|
Скрыть элементы QR-кода под логотипом |
logobgclearform |
Список
Значения: 0
- круглая
;
1
- прямоугольная
;
|
"0"
|
Форма скрытия элементов |
qrmarker |
Строка
Значения: rectangle
- Квадраты
;
rounded_10
- Загругленный 10%
;
rounded_30
- Загругленный 30%
;
circle
- Кружки
;
|
""
|
Узор угловых маркеров QR-кода
По умолчанию - квадраты |
is_qrmarkercolor |
Число
Значения: 0
- нет
;
1
- да
;
|
"0"
|
Отдельный цвет для маркеров |
qrmarkercolor |
Строка | "#000000"
|
Цвет маркера
По умолчанию - черный (#000000) |
qrmarkercenter |
Строка
Значения: rectangle
- Квадраты
;
rounded_10
- Загругленный 10%
;
rounded_30
- Загругленный 30%
;
circle
- Кружки
;
|
""
|
Узор центроы угловых маркеров QR-кода
По умолчанию - квадраты |
is_qrmarkercentercolor |
Число
Значения: 0
- нет
;
1
- да
;
|
"0"
|
Отдельный цвет для центров маркеров |
qrmarkercentercolor |
Строка | "#000000"
|
Цвет центра маркера
По умолчанию - черный (#000000) |
is_text |
Список
Значения: 1
- Текст
;
2
- Значение параметра динамического кода
;
3
- Значения пользовательского параметра
;
|
""
|
Добавить текст в изображение QR-кода |
fontsize |
Список
Значения: 8
;
10
;
11
;
12
;
13
;
14
;
16
;
18
;
20
;
22
;
24
;
26
;
28
;
30
;
36
;
48
;
|
"12"
|
Размер шрифта, pt |
textcolor |
Строка | "#000000"
|
Цвет текста
По умолчанию - черный (#000000) |
qrtext |
Строка | ""
|
Текст |
qrfieldsystem |
Список
Значения: uid; guid; name
|
""
|
Системный параметр QR-кода |
qrfielduser |
Список
Значения: title;
category;
description;
h3;
promoimg_lg;
promoimg_sm;
url;
h3;
limittype;
count_max;
date_begin;
date_end;
h3;
buttontext;
buttontext_color;
buttontext_bgcolor;
h3;
is_form_hide;
is_email_required;
is_phone_required;
is_select1_required;
select1;
select1_data;
select1_comment;
is_select2_required;
select2;
select2_data;
select2_comment;
h3;
success_text;
success_img;
link_success;
url_success;
h3;
expired_text;
expired_img;
h3;
limit_text;
limit_img;
h3;
couponpass;
is_email_unique;
is_phone_unique;
h3;
is_couponinfo;
couponinfo_buttontext;
couponinfo_link;
couponinfo_text;
h3;
couponemail_img;
couponemail_text (опционально);
|
""
|
Пользовательский параметр QR-кода |
