Отзывы и жалобы обо всем. Защити свои права потребителя!

Информация о виджете


Общая информация

Перед использованием виджета на своем сайте вам необходимо получить ключ именно для вашего доменного имени. Это вы можете сделать перейдя на страницу ключей и нажав кнопку "Запросить новый ключ". Во всплывшем диалоговом окне вам необходимо ввести доменное имя сайта на который вы хотите установить виджет и телефон для связи с вами. Доменное имя следует вводить без префиксов типа 'http://' или 'www'. Например, просто 'yabeda.by'. Ключ будет привязан к данному доменному имени и виджет с этим ключом будет работать только со страниц с этого домена. После отправки заявки на получения ключа она будет рассмотрена администратором. Как только он одобрит вашу заявку вы получите уведомление об этом по электронной почте и на странице ключей в списке появится ваш ключ. В таблице ключей указаны все ключи виджета пользователя. Их может быть несколько, но не более одного для одного доменного имени. Если вам нужно установить виджет для другого домена можно еще раз запросить новый ключ для нового доменного имени. В таблице указаны непосродственно ключ виджета, домен для которого он выдан, ключ sso (работа с SSO будет рассмотрена ниже) и иконки действий.

Виджет yabeda.by позволяет легко внедрить отзывы о каком-либо объекте в вашу страницу. Пользователи будут иметь возможность просматривать все одобренные отзывы и оставлять свои отзывы. Для того чтобы оставить свой отзыв пользователю необходимо залогиниться. Это можно сделать используя свой аккаунт в любой из популярных соцсетей (Google, Яндекс, Вконтакте, facebook, twitter, Одноклассники и т.д) либо через аккаунт на сайте yabeda.by (зарегистрироваться можно тоже используя виджет). Если на вашем сайте уже есть система аутентификации пользователей то можно настроить Single Sign On, что даст возможность пользователю залогинившись на вашем сайте автоматически залогиниться и в виджет.


Установка виджета

Для использования виджета необходимо чтобы была подключена библиотека jQuery. Если вы ее не используете, то перед использованием виджета необходимо ее подключить. Сделать это можно например через сервера компании google добавив в вашу страницу следующий код

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>

Также вам надо в желаемом месте на странице создать контейнер, куда виджет будет выводить информацию. Для идентификации этого контейнера ему нужно задать атрибут id. Это можно сделать, например, с помощью подобного HTML кода

<div id="widget"></div>

После того как библиотека jQuery подключена и создан контейнер для виджета можно внедрять его на страницу. Для этого ПОСЛЕ строки с подключением jQuery нужно подключить код виджета, проинициализировать объект виджета передав ему некоторые параметры и вызвать метод draw() для его отображения.

Для отображения отзывов об объекте виджету необходимо передать о нем данные (имя, адрес и категорию объекта), id контейнера для показа виджета и ваш ключ. Категория объекта должна существовать, имя и адрес объекта - не обязательно. Вам необходимо выбрать подходящую для вашего объекта категорию. Это можно сделать на странице подачи жалобы использую всплывающие подсказки для поля "Объект отзыва". Замечание: Необходимо указывать последнюю категорию с дереве категорий для вашего объекта. Например если мы хотим разместить на странице отзыв о каком-либо интернет-сайте то подходящая для этого категория Hi-Tech/Интернет/Сайты. Для виджета в параметре category указываем последнюю (самую точную) из подходящих категорий, а именно 'Сайты'. Если у вас затруднения по поводу нахождения соответствующей категории или нужная категория не существует пожалуйста свяжитесь с нами. Адрес объекта и его имя не обязательно должны уже существовать в базе данных. Если на этот объект уже есть отзывы в нашей базе данных то они будут показаны, если же нету то пользователю будет предложено первым оставить свой отзыв об этом объекте. Ниже пример инициализации виджета с отзывами о сайте locator.by. Конечно ключ вам надо свой, а не "your_widget_key" из примера.

<script src="https://yabeda.by/assets/api/yabedawdg.js"></script> <script> $(function() { new Yabedawdg({key: "your_widget_key", block: '#widget', address: '', name: 'locator.by', category: 'Сайты'}).draw(); }) </script>

После этого на своей странице вы можете увидеть виджет. Примерный вид виджета показан на рисунке ниже.

Вот пример подключения виджета отзывов о кафе с именем 'Кафе Театро' расположенного по адресу 'Минск, улица Максима Богдановича, 6'

<script src="https://yabeda.by/assets/api/yabedawdg.js"></script> <script> $(function() { new Yabedawdg({key: "your_widget_key", block: '#widget', address: 'Минск, улица Максима Богдановича, 6', name: 'Кафе Театро', category: 'Кафе'}).draw(); }) </script>

Вы можете посмотреть в действии пример 1 и пример 2

Подключение jQuery в конце страницы

Возможна ситуация когда библиотека jQuery подключается в самом конце страницы из соображений уменьшения времени загрузки данных. В таком случае вам необходимо инициализировать виджет также в конце страницы после подключения jQuery. Однако (если, например, у вас в шаблоне нижней части страницы где подключается jQuery недоступны данные объекта отзыва) создать объект с данными для виджета вы можете в любом месте до его вызова (в том числе и до подключения jQuery). Схематично это можно показать так

<html> ..... контейнер для виджета <div id="widget"></div> ..... Инициализируем данные для виджета (jQuery не требуется) <script> yabedawdg_data = {key: "your_widget_key", block: '#widget', address: '', name: 'locator.by', category: 'Сайты'} </script> ..... Подключаем jQuery <script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script> Отображаем виджет по ранее инициализированным данным <script> $(function() { new Yabedawdg(yabedawdg_data).draw();}) </script> </html>
Дополнительные параметры

Если вы хотите изменить вид виджета то можно использовать для этого дополнительные параметры. Просто добавьте эти параметры через запятую после обязательных параметров.

one_line: true Передав такой параметр вы переводите виджет в одноотзывный режим показа. В этом режиме всегода отображается только один отзыв. Переход по отзывам происходит по нажатию навигационных кнопок под отзывом. Пример такого вида можно увидеть на рисунке ниже.

hide_object_info: true Этот параметр скрывает отображение информации об объекте отзывов (название и адрес). Это может быть полезным если у вас страница полностью посвящена этому объекту и уже содержит его название и адрес в другом месте.

css_path: Позволяет указать другой путь к файлу стилей. Вы можете скачать наш файл стилей, изменить его под свои нужды, поместить на свой сервер и с помощью параметра css_path указать виджету на необходимость использования модифицированного файла стилей с вашего сервера.

cssoneline_path: Аналогично параметру css_path позволяет указать другой путь к файлу стилей для навигации между отзывами в одноотзывном режиме. Вы можете скачать наш файл стилей для одноотзывного режима, изменить его под свои нужды, поместить на свой сервер и с помощью параметра cssoneline_path указать виджету на необходимость использования модифицированного файла. Замечание: этот файл только описывает панель навигации и содежрит встроенные картинки для них. Для изменения других параметров действует основной файл стилей (параметр css_path:)

theme: Установка темы расцветки виджета. В этот параметр вы можете передать имя темы (например blue или green) для смены расцветки либо изменить наш файл темы под свои нужды, и передать в параметр theme url вашего измененного файла темы. Замечание: Файл стиля темы гораздо меньше чем основной файл стиля указываемый в css_path:. Он применяется после этого файла и меняет цвета (и возможно размеры) некоторых элементов виджета. Это удобно использовать когда вы хотите сделать небольшие изменения, но не хотите разбираться в большом файле стилей виджета


Работа с Single Sign On (SSO)

SSO предоставляет возможность пользователю залогинившись на вашем сайте автоматически залогиниться также и в виджет. Для этого необходимо чтобы ваш сайт сгенерировал и передал в виджет в параметре sso_data специальным образом сконструрированную строку в которой будут зашифрованы такие данные как имя пользователя, его email адрес и ссылка на аватар. Замечание: обязательными являются только параметры name (имя залогиненного на вашем сайте пользователя) и email (адрес его электронной почты) Генерирование этой строки зависит от языка программирования на котором написан ваш серверный функционал.

Значение переменной должно формироваться на сервере и быть равно:

<JSON данные пользователя в Base64><пробел><MD5 подпись запроса><пробел><текущее время в секундах>

JSON данные пользователя включают в себя следующие атрибуты:

  • name — имя пользователя
  • email — адрес электронной почты
  • avatar (необязательное) — ссылка на аватар

MD5 подпись запроса формируется как:

md5(<JSON данные пользователя в Base64><SSO Key><текущее время в секундах>)

Ниже приведен пример генерирования строки SSO на языке PHP и вызов виджета с дополнительными параметрами (в том числе и sso_data). Подразамевается что у вас имеется переменная $user которая содержит поля name и email в которых хранятся соответственно имя и емейл залогиненного пользоватля. Этот пример предназначен для случая если у вас НЕ AJAX аутентификация пользователей (т.е. после входа пользователя страница перегружается полностью)

    <?php $userstr = array('name' => $user->name, 'email' => $user->email, 'avatar' => '$user->avatar_url'); $ssoKey = "your_sso_key"; $user_data = base64_encode(json_encode($userstr)); $timestamp = time(); $sign = md5($user_data . $ssoKey . $timestamp); ?>; <script src="https://yabeda.by/assets/api/yabedawdg.js"></script> <script> $(function(){ yabedawdg_data = {key: "your_widget_key", block: '#widget', address: 'Минск, улица Сурганова, 2 ', name: 'Прадагрупп', category: 'Ремонт телефонов', one_line: true, hide_object_info: true, css_path: "http://mysite.ru/assets/api/yabedawdgCustom.css", cssoneline_path: "http://mysite.ru/assets/api/yabedawdg_onelineCustom.css", sso_data: '&lt;?php echo "$user_data $sign $timestamp"; ?>'} ywdg = new Yabedawdg(yabedawdg_data).draw(); }) </script>

Аналогичный пример генерирования строки SSO на языке Ruby (фреймворк Ruby On Rails). В этом примере предполагается что у вас имеется переменная current_user которая также содержит поля name и email. Необязательное поле avatar отсутствует.

<% if current_user require 'base64' require 'digest/md5' user = { 'name' => current_user.name,'email' => current_user.email} timestamp = Time.now.to_i.to_s user_base64 = Base64.encode64(user.to_json).gsub(/\n/,'') ssoKey = "your_sso_key" sign = Digest::MD5.hexdigest(user_base64 + ssoKey + timestamp ) end %> <script src="https://yabeda.by/assets/api/yabedawdg.js"></script> <script> $(function() { yabedawdg_data = {key: "your_widget_key", block: '#widget', address: 'Минск, улица Сурганова, 2 ', name: 'Прадагрупп', category: 'Ремонт телефонов', sso_data: '<%= current_user ? user_base64 + ' ' + sign + ' ' + timestamp : '' %>' } ywdg = new Yabedawdg(yabedawdg_data).draw(); }) </script>

Если же у вас после логина пользователя отправляется AJAX запрос на сервер, то для аутентификации пользователя по SSO в виджете необходимо точно также на стороне сервера сгенерировать строку данных для SSO и в javascript ответе вызвать метод set_sso_data объекта виджета. При этом при изначальной инициализации виджета если пользователь еще не залогинен параметр sso_data указывать не нужно.

ywdg.set_sso_data('<%= user_base64 + ' ' + sign + ' ' + timestamp %>')

Настройка параметров ключа

На странице ключей кликнув на пиктограмму "Настроить параметры ключа" можно перейти на страницу настройки параметров выбранного ключа. На этой странице вы можете изменить тип модерации ваших отзывов и настроить режим разделения отзывов для вашего виджета


Тип модерации определяет правило появления написанного отзыва и может принимать одно из следующих значений

- Yabeda Отзыв пользователя не будет появляться в виджете пока его не одобрит модератор сайта yabeda.by

- Клиентская Вы сами на странице модерации сможете одобрять или отклонять отзывы. Отзыв будет опубликован только после его одобрения.

- Отсутствует Отзывы опубликовываются сразу и не трубуют подтверждения


Режим показа отзывов определяет правила в соответствии с которыми ваш виджет будет отображать отзывы, поданные с других сайтов на этот же объект или делиться своими отзывами с другими сайтами

- Изолированный В этом режиме ваш виджет показывает только отзывы через него же и поданные. Ваши отзывы также не доступны и другим виджетам.

- Расширенный В этом режиме появляется дополнительная настройка где вы можете выбрать домены с которых вы хотите отображать отзывы. Также вы можете указать список доменов с которыми вы НЕ ЖЕЛАЕТЕ делиться своими отзывами


Модерация отзывов

Если в настройках ключа Тип модерации установлен как Клиентская то на странице ключей напротив этого ключа в колонке действий будет отображаться и пиктограмма Модерировать отзывы. Кликнув на нее вы попадете на страницу можерации отзывов данного виджета которая представляет собой таблицу отзывов с фильтрами для отображения нужных отзывов и с колонкой действий. Над отзывом доступны 2 действия: Одобрить и Отклонить. В виджете будут отображаться только одобренные вами отзывы. ЗАМЕЧАНИЕ: по умолчанию выставлен фильтр показа только новых отзывов. Если вы хотите увидеть одобренные или отклоненные отзывы поменяйте фильтр для поля Статус на необходимое вам

Яндекс.Метрика