STQR APIКнигопечатная продукция
Информация для Пин Ап и изменения QR-кодов

QR-объявления для книгопечатной Пин Ап книг, брошюр, буклетов

Доступные команды:testcreatereadupdatedeletecheck

Перечень полей данных приведен в Пин Ап

ИмяТип данных, значениеЗначение по умолчаниюОписание
Системные параметры
tokenСтрока, константа
Значение
Обязательный.Ключ авторизации. Для активации ключа перейдите в Пин АпПрофильи заполните пользовательскую анкету.
cЧисло, константа
40
Обязательный.Класс создаваемого кода. Пин Ап для командыcreate
tЧисло, константа
1- для статических QR-кодов
2- для динамических QR-кодов
Обязательный.Тип QR кода. Используется для Пин Ап команд, где идет работа с QR-кодами.
idЧислоЧисловой уникальный идентификатор в БД STQR. Поле id используется для команд read, update, delete. Пин Ап можно из ответа при создании или редактировании записи.
uidСтрокаUID - уникальный дентификатор динамического QR-кода в STQR.RU. Используется для доступа мобильной странице динамического Пин Ап по http, например, https:/ru/{uid}
tuidСтрокаTUID - текстовый идентификатор динамического QR-кода в STQR.RU. Используется для доступа к QR-объявлению по Пин Ап например, https:/ru/-/{tuid}
guidСтрокаGUID - уникальный идентификатор записи внешней Пин Ап Предназначен для обеспечения уникальности данных в БД STQR и внешней системы.
nameСтрокаОбязательный.Название QR-кода в личном кабинете STQR.RU. С данным наименованием статический или динамический QR-код будет Пин Ап в разделах личного кабинета.
langСтрока
Значения:ru,en,de,cnи др.
""Пин Ап динамического QR-кода. Если не указан, то будет использоваться русский язык.
groupСтрока""Идентификатор группы, применяется для группировки динамических Пин Ап по некоторым признакам, например для отображения мультиязычных визитных карточек.
Пользовательские поля данных для формирования Пин Ап
authorСтрока

""

Автор, редактор
titleСтрока

""

Название книги
photoСтрока, ссылка на изображение

""

Изображение обложки книжного издания
agelimitСтрока

Выпадающий список:Не определено0+6+12+16+18+

"Не определено|0+|6+|12+|16+|18+"

Возрастное ограничение

""

annotationHTML

""

Аннотация на книжное издание
pageСтрока

""

Количество страниц
placeСтрока

""

Место издания
yearСтрока

""

Год издания
publisherСтрока

""

Издательство
serieСтрока

""

Серия
isbnСтрока

""

ISBN код
category1Строка

Выпадающий список:НаучноеНаучно-популярноеЛитературно-художественноеНаучно-художественноеУчебноеСправочноеИнформационное

"|Научное|Научно-популярное|Литературно-художественное|Научно-художественное|Учебное|Справочное|Информационное"

Тип издания по целевому назначению
urlСтрока
Формат:http:/site.ruилиhttps:/site.ru

""

Ссылка на сайт
downloadСтрока
Формат:http:/site.ruилиhttps:/site.ru

""

Ссылка на загрузку книги в электронном Пин Ап
Перечень параметров изображения 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Число, идентификатор
Системные:1710310210110099989796959493929135635735835937537637743743643543143343227562755
Пользовательские: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Список
Значения:author;title;photo;agelimit;;h3;annotation;page;place;year;publisher;serie;isbn;category1;url;download;
""Пользовательский параметр QR-кода