STQR API -> Пригласительный билет/купон на скидку
Информация для создания и изменения QR-кодов
Динамический QR-код позволяющий получить рекламный/скидочный купон или, пригласительный билет
Доступные команды:
test
create
read
update
delete
check
Перечень полей данных приведен в таблице:
Имя | Тип данных, значение | Значение по умолчанию | Описание |
---|---|---|---|
Основные параметры | |||
token |
Строка | Его необходимо получить из поля token в разделе Профиль | Ключ авторизации |
c |
44 Число, константа |
Класс создаваемого кода. Только для команды create |
|
t |
1 - для статических QR-кодов2 - для динамических QR-кодовЧисло, константа |
Тип QR кода. Используется для всех команд, где идет работа с QR-кодами. | |
id |
Число | числовой уникальный идентификатор в БД STQR. Поле id используется для команд read, update, delete | |
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 |
По умолчанию: |
Текст |