STQR APIДинамическая визитка (vCard)
Информация для Пин Ап и изменения QR-кодов
Электронная визитная карточка, предоставляющая контактные данные, фотографию, организацию и должность и Пин Ап на социальные сети.
Доступные команды:testcreatereadupdatedeletecheck
Перечень полей Пин Ап приведен в таблице:
| Имя | Тип данных, значение | Значение по умолчанию | Описание |
|---|---|---|---|
| Системные параметры | |||
token | Строка, константа Значение | Обязательный.Ключ авторизации. Для активации Пин Ап перейдите в разделПрофильи заполните пользовательскую анкету. | |
c | Число, константа18 | Обязательный.Класс создаваемого кода. Пин Ап для командыcreate | |
t | Число, константа1- для статических QR-кодов2- для динамических QR-кодов | Обязательный.Тип QR кода. Используется для всех команд, где Пин Ап работа с QR-кодами. | |
id | Число | Числовой уникальный идентификатор в БД STQR. Поле id используется для команд read, Пин Ап delete. Получить можно из ответа при создании или редактировании записи. | |
uid | Строка | UID - уникальный дентификатор динамического QR-кода в STQR.RU. Используется для доступа мобильной странице динамического QR-кода по Пин Ап например, https:/ru/{uid} | |
tuid | Строка | TUID - текстовый идентификатор динамического QR-кода в STQR.RU. Используется для доступа к QR-объявлению по Пин Ап например, https:/ru/-/{tuid} | |
guid | Строка | Пин Ап - уникальный идентификатор записи внешней системы. Предназначен для обеспечения уникальности данных в БД STQR и внешней системы. | |
name | Строка | Обязательный.Название QR-кода в личном кабинете STQR.RU. С данным наименованием статический или Пин Ап QR-код будет отображаться в разделах личного кабинета. | |
lang | Строка Значения: ru,en,de,cnи др. | "" | Язык динамического QR-кода. Если не указан, то будет использоваться русский Пин Ап |
group | Строка | "" | Идентификатор группы, применяется для группировки динамических QR-кодов по некоторым Пин Ап например для отображения мультиязычных визитных карточек. |
| Пользовательские поля данных для Пин Ап QR-кода | |||
lastname | Строка |
| Фамилия |
firstname | Строка |
| Имя |
middlename | Строка |
| Отчество |
birthday | Строка Значения: 2019-12-31 |
| Дата рождения |
photo | Строка, ссылка на изображение |
| Фотография #1 |
photo_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Cсылка для фотографии #1 |
photo2 | Строка, ссылка на изображение |
| Фотография #2 |
photo_url2 | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Cсылка для фотографии #2 |
photo3 | Строка, ссылка на изображение |
| Фотография #3 |
photo_url3 | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Cсылка для фотографии #3 |
company | Строка |
| Организация, компания |
department | Строка |
| Департамент, отдел |
jobtitle | Строка |
| Должность |
workphone | Строка Формат: +79012345678 |
| Рабочий телефон |
workphone2 | Строка Формат: +79012345678 |
| Рабочий телефон #2 |
cellphone | Строка Формат: +79012345678 |
| Мобильный телефон |
cellphone2 | Строка Формат: +79012345678 |
| Мобильный телефон #2 |
email | Строка |
| |
email2 | Строка |
| Email #2 |
website_url | Строка |
| Интернет-сайт |
website_url2 | Строка |
| Интернет-сайт #2 |
fax | Строка Формат: +79012345678 |
| Факс |
joblogo | Строка, ссылка на изображение |
| Фотография/логотип для должности |
address | Строка |
| Адрес |
city | Строка |
| Город |
state | Строка |
| Регион, область |
country | Строка |
| Страна |
postcode | Строка |
| Почтовый индекс |
notes | HTML |
| Заметки |
company_2 | Строка |
| Организация, компания |
department_2 | Строка |
| Департамент, отдел |
jobtitle_2 | Строка |
| Должность |
workphone_2 | Строка Формат: +79012345678 |
| Рабочий телефон |
workphone_2 | Строка Формат: +79012345678 |
| Рабочий телефон #2 |
cellphone_2 | Строка Формат: +79012345678 |
| Мобильный телефон |
cellphone_2 | Строка Формат: +79012345678 |
| Мобильный телефон #2 |
email_2 | Строка |
| |
email2_2 | Строка |
| Email #2 |
website_url_2 | Строка |
| Интернет-сайт |
website_url2_2 | Строка |
| Интернет-сайт #2 |
fax_2 | Строка Формат: +79012345678 |
| Факс |
joblogo_2 | Строка, ссылка на изображение |
| Фотография/логотип для должности #2 |
address_2 | Строка |
| Адрес |
city_2 | Строка |
| Город |
state_2 | Строка |
| Регион, область |
country_2 | Строка |
| Страна |
postcode_2 | Строка |
| Почтовый индекс |
notes_2 | HTML |
| Заметки |
company_3 | Строка |
| Организация, компания |
department_3 | Строка |
| Департамент, отдел |
jobtitle_3 | Строка |
| Должность |
workphone_3 | Строка Формат: +79012345678 |
| Рабочий телефон |
workphone_3 | Строка Формат: +79012345678 |
| Рабочий телефон #2 |
cellphone_3 | Строка Формат: +79012345678 |
| Мобильный телефон |
cellphone_3 | Строка Формат: +79012345678 |
| Мобильный телефон #2 |
email_3 | Строка |
| |
email2_3 | Строка |
| Email #2 |
website_url_3 | Строка |
| Интернет-сайт |
website_url2_3 | Строка |
| Интернет-сайт #2 |
fax_3 | Строка Формат: +79012345678 |
| Факс |
joblogo_3 | Строка, ссылка на изображение |
| Фотография/логотип для должности #3 |
address_3 | Строка |
| Адрес |
city_3 | Строка |
| Город |
state_3 | Строка |
| Регион, область |
country_3 | Строка |
| Страна |
postcode_3 | Строка |
| Почтовый индекс |
notes_3 | HTML |
| Заметки |
telegram | Строка |
| Telegram аккаунт |
telegram2 | Строка |
| Telegram аккаунт #2 |
max_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Max (логин или ссылка на Пин Ап |
whatsapp_number | Строка Формат: +79012345678 |
| WhatsApp номер |
wechat_number | Строка Формат: +79012345678 |
| WeChat номер |
viber_number | Строка Формат: +79012345678 |
| Viber номер |
corporate | Строка Формат: +79012345678 |
| Корпоративный мессенджер |
skype | Строка |
| Skype |
blog_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Блог |
vk_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| ВКонтакте |
ok_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Одноклассники |
facebook_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| |
instagram_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| |
instagram_url2 | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Instagram #2 |
foursquare_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Foursquare |
linked_in_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| |
pinterest_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| |
snapchat_username | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Snapchat |
twitch_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Twitch |
twitter_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| |
tumblr_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Tumblr |
youtube_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Youtube |
meetup_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Meetup |
weibo_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| |
tiktok_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| TikTok |
rutube_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| RuTube |
dzen_url | Строка Формат: http:/site.ruилиhttps:/site.ru |
| Дзен |
photo_android | Строка, ссылка на изображение |
| Изображение для экспорта Пин Ап на Android |
photo_ios | Строка, ссылка на изображение |
| Изображение для экспорта Пин Ап на iOS |
export_notes | Текст |
| Текстовый комментарий для экспорта визитки |
| Перечень параметров изображения 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 27 31 32 33 34 36 39 41 42 45 47 48 46 49 53 57 58 59 54 50 40 103 102 101 100 99 98 97 96 95 94 93 92 91 106 107 108 356 357 358 359 375 376 377 437 436 435 431 433 432 2756 2755Пользовательские:  12 13 14 15 1617 18 19 20 2127 2829 3031323334 3536 3739404142 43 44454647484950 51 525354 56575859 60 61 62 63 64 65 66919293949596979899100101102103106107108356357358359375376377431432433435436437 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 | Список Значения: lastname;firstname;middlename;birthday;h2;photo;photo_url;photo2;photo_url2;photo3;photo_url3;h2;company;department;jobtitle;workphone;workphone2;cellphone;cellphone2;email;email2;website_url;website_url2;fax;joblogo;h4;address;city;state;country;postcode;notes;h2;company_2;department_2;jobtitle_2;workphone_2;workphone_2;cellphone_2;cellphone_2;email_2;email2_2;website_url_2;website_url2_2;fax_2;joblogo_2;h4;address_2;city_2;state_2;country_2;postcode_2;notes_2;h2;company_3;department_3;jobtitle_3;workphone_3;workphone_3;cellphone_3;cellphone_3;email_3;email2_3;website_url_3;website_url2_3;fax_3;joblogo_3;h4;address_3;city_3;state_3;country_3;postcode_3;notes_3;h2;telegram;telegram2;max_url;whatsapp_number;wechat_number;viber_number;corporate;skype;h2;blog_url;vk_url;ok_url;facebook_url;instagram_url;instagram_url2;foursquare_url;linked_in_url;pinterest_url;snapchat_username;twitch_url;twitter_url;tumblr_url;youtube_url;meetup_url;weibo_url;tiktok_url;rutube_url;dzen_url;h2;photo_android;photo_ios;export_notes; | "" | Пользовательский параметр QR-кода |
