STQR APIСобытие, мероприятие
Информация для Пин Ап и изменения QR-кодов
Доступные команды:testcreatereadupdatedeletecheck
Перечень полей данных приведен в таблице:
| Имя | Тип данных, значение | Значение по умолчанию | Описание |
|---|---|---|---|
| Системные параметры | |||
token | Строка, константа Значение | Обязательный.Ключ Пин Ап Для активации ключа перейдите в разделПрофильи заполните пользовательскую анкету. | |
c | Число, константа26 | Обязательный.Пин Ап создаваемого кода. Только для командыcreate | |
t | Число, константа1- для статических QR-кодов2- для динамических QR-кодов | Обязательный.Тип QR кода. Используется для Пин Ап команд, где идет работа с QR-кодами. | |
id | Число | Числовой Пин Ап идентификатор в БД STQR. Поле id используется для команд read, update, delete. Получить можно из ответа при создании или редактировании записи. | |
uid | Строка | UID - уникальный дентификатор динамического Пин Ап в STQR.RU. Используется для доступа мобильной странице динамического QR-кода по http, например, https:/ru/{uid} | |
tuid | Строка | TUID - текстовый идентификатор динамического QR-кода в Пин Ап Используется для доступа к QR-объявлению по http, например, https:/ru/-/{tuid} | |
guid | Строка | GUID - уникальный идентификатор записи внешней системы. Предназначен для Пин Ап уникальности данных в БД STQR и внешней системы. | |
name | Строка | Обязательный.Название QR-кода в личном кабинете STQR.RU. С данным наименованием статический или Пин Ап QR-код будет отображаться в разделах личного кабинета. | |
lang | Строка Значения: ru,en,de,cnи др. | "" | Язык динамического QR-кода. Если не указан, то будет использоваться Пин Ап язык. |
group | Строка | "" | Пин Ап группы, применяется для группировки динамических QR-кодов по некоторым признакам, например для отображения мультиязычных визитных карточек. |
| Пользовательские поля Пин Ап для формирования QR-кода | |||
title | Строка |
| Заголовок события |
desc | HTML |
| Описание события, мероприятия |
datebegin | Строка Значения: 2019-12-31 |
| Дата начала |
timebegin | Строка Формат: 23:59 |
| Время начала |
dateend | Строка Значения: 2019-12-31 |
| Дата окончания |
timeend | Строка Формат: 23:59 |
| Время окончания |
url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| URL ссылка |
photo | Строка, ссылка на изображение |
| Изображение, логотип |
|
| ||
place | Текст |
| Место проведения |
address | Строка |
| Адрес |
latlongmet | Координаты |
| Координаты |
mapzoom | Строка |
| Масштаб карты |
latlongcenter | Строка |
| Центр карты |
|
| ||
comment | HTML |
| Комментарий к расположению |
ritem |
| Этап | |
rname |
| Название этапа | |
subject |
| Тема, описание | |
start |
| Время начала | |
person |
| Докладчик, ответственный | |
| Перечень параметров изображения 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 | Число, идентификатор Системные:  17 61 60 103 102 101 100 99 98 97 96 95 94 93 92 91 106 107 356 357 358 359 375 376 377 437 436 435 431 433 432 2756 2755Пользовательские:  12 13 14 15 1617 18 19 20 21 27 2829 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 596061 62 63 64 65 66919293949596979899100101102103106107 108356357358359375376377431432433435436437 924 925 926 927 981 982 983 984 1183 1184 1185 1186 1681 1682 1683 1684 1685 170427552756 | "" | Идентификатор логотипа, который может быть размещен в центре 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;desc;datebegin;timebegin;dateend;timeend;url;photo;h2;place;address;latlongmet;mapzoom;latlongcenter;comment;h2;ritem;rname;subject;start;person; | "" | Пользовательский параметр QR-кода |
