STQR APIПригласительный билет/купон на скидку
Информация для создания и изменения Пин Ап
Динамический QR-код позволяющий получить рекламный/скидочный купон или, пригласительный Пин Ап
Доступные команды:testcreatereadupdatedeletecheck
Перечень полей данных приведен в Пин Ап
| Имя | Тип данных, значение | Значение по умолчанию | Описание |
|---|---|---|---|
| Системные параметры | |||
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:/ru/{uid} | |
tuid | Строка | TUID - текстовый идентификатор динамического QR-кода в STQR.RU. Пин Ап для доступа к QR-объявлению по http, например, https:/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:/site.ruилиhttps:/site.ru |
| Ссылка на сайт с описанием рекламной Пин Ап |
|
| ||
limittype | Строка Выпадающий список: |
| Категория, тип |
count_max | Число |
| Максимальное количество купонов |
date_begin | Строка Значения: 2019-12-31 |
| Дата начала действия акции |
date_end | Строка Значения: 2019-12-31 |
| Дата окончания действия акции |
|
| ||
buttontext | Строка |
| Надпись на кнопке получения купона |
buttontext_color | Строка Формат: #050000или#123 |
| Цвет текста кнопки |
buttontext_bgcolor | Строка Формат: #050000или#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:/site.ruилиhttps:/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 Определяет размер элемента Пин Ап в пикселях. |
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 | Число, идентификатор Системные: 10310210110099989796959493929135635735835937537637743743643543143343227562755Пользовательские: 121314151617181920212728293031323334353637394041424344454647484950515253545657585960616263646566919293949596979899100101102103106107108356357358359375376377431432433435436437924925926927981982983984118311841185118616811682168316841685170427552756 | "" | Идентификатор логотипа, который может быть размещен в центре 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-кода |

