API QR-кодов
С помощью генератора можно создавать QR-коды и короткие ссылки, ведущие на страницы написания отзывов или на любые другие страницы. Инструмент позволит менять направления ссылок без замены самой короткой ссылки и QR-кода , что важно как в онлайн, так и в офлайн рекламе.
Создание новых QR-кодов для сбора отзывов
Для создания используйте ссылку: https://pinbox.ru/api2/qrcode/?token=<ВАШ_ТОКЕН>&method=createQrcode
Метод POST
title (обязательный) – произвольное название создаваемого QR-кода. Любая строка. Не более 100 символов.
card (необязательный) – идентификатор филиала (найти его можно в кабинете Pinbox, например: "22645"). Если не указать, QR-код будет использован для всех филиалов.
hervest_flg (необязательный) – флаг включения сбора данных в форме с положительным отзывом. Значения: "on" или "off".
flg_filter (необязательный) – флаг включения фильтрации отзывов. Значения: "on" или "off".
flg_promo (необязательный, условный) – флаг активации промо-акции. Значения: "on" или "off". Доступен, если включен flg_filter.
gen_promo (необязательный, условный) – флаг генерации промо-кодов для акции. Значения: "on" или "off". Доступен, если включен flg_promo.
promo_description (обязательный, условный) – краткое описание промо-акции. Показывается пользователям. Доступен, если включен flg_promo. Не более 250 символов.
promo_np (обязательный, условный) – настройка фильтра отзывов для акции. Значения: "0" - для любых отзывов, "1" - только для положительных, "2" - только для отрицательных. Доступен, если включен flg_promo.
Для работы QR-кода обязательно передать хотя бы один параметр use_*
use_yandex (необязательный) – интеграция с Яндекс Картами. Значения: "on" или "off". Ссылка на карты будет сгенерирована автоматически, на основании подключения к Яндекс филиала.
use_google (необязательный) – интеграция с Google Картами. Значения: "on" или "off". Ссылка на карты будет сгенерирована автоматически, на основании подключения к Google филиала.
use_2gis (необязательный) – интеграция с 2ГИС. Значения: "on" или "off". Ссылка на карты будет сгенерирована автоматически, на основании подключения к 2ГИС филиала.
use_other (необязательный) – флаг включающий возможность прямого указанием ссылки на геосервис. Значения: "on" или "off".
link_other (условно-обязательный) – ссылка на геосервис. Корректный URL-адрес. Обязателен, если параметр use_other имеет значение "on".
Максимальный пример json для создания
Минимальный пример json для создания
Ответ json – cозданный QR-код
address – адрес филиала для которого был создан QR-код,
id – идентификатор QR-кода,
link_img – ссылка на изображение QR-кода,
link_2gis, link_yandex, link_google, link_other – ссылки для переходов,
link_write_review – ссылка на которую ведет QR-код,
date – дата создания,
promo_description – описание рекламной акции
Получение информации по QR-кодам
Для получения данных используйте ссылку: https://pinbox.ru/api2/qrcode/?token=<ВАШ_ТОКЕН>&method=getData&offset=0
Метод GET
offset – смещение для постраничной выгрузки, не обязательный параметр
Ответ json
Блок Data
address – адрес филиала для которого был создан QR-код,
id – идентификатор QR-кода,
link_img – ссылка на изображение QR-кода,
link_2gis, link_yandex, link_google, link_other – ссылки для переходов,
link_write_review – ссылка на которую ведет QR-код,
date – дата создания,
promo_description – промо описание
Блок Stat
total – общее число QR-кодов,
offset – текущее смещение
Получение информации по одному QR-коду
Для получения данных используйте ссылку: https://pinbox.ru/api2/qrcode/?token=<ВАШ_ТОКЕН>&method=getData&id=<НОМЕР_QR>
Метод GET
id – идентификатор QR-кода
Ответ json
address – адрес филиала для которого был создан QR-код,
id – идентификатор QR-кода,
link_img – ссылка на изображение QR-кода,
link_2gis, link_yandex, link_google, link_other – ссылки для переходов,
link_write_review – ссылка на которую ведет QR-код,
date – дата создания,
promo_description – промо описание
Статистика QR-кодов
Для получения данных используйте ссылку: https://pinbox.ru/api2/qrcode/?token=<ВАШ_ТОКЕН>&method=getStatistic
Метод GET
offset — смещение для постраничной выгрузки, не обязательный параметр
Ответ json
Блок Data
filter – количество заполнений формы фильтра с негативным отзывом,
on_geo – количество переходов на геосервисы,
on_qr – количество переходов по QR,
title – название QR-кода
Блок Stat
total – общее число QR-кодов,
offset – текущее смещение
Блок total_amount с общей суммой всех QR
filter – количество заполнений формы фильтра с негативным отзывом по всем представленным кодам,
on_geo – переходы на геосервисы,
on_qr – переходы по QR
Общие ошибки
Метод указан не верно
{ "status": false, "error": "Invalid method"}
Превышен дневной лимит создания QR-кодов
{ "status": false, "error": "Limit exceeded"}