Документация к карточному виджету
Назначение виджета.
Карточный виджет показывает доступные варианты доставки для выбранного региона. Встроив этот виджет на страницу товара, вы предоставите своим клиентам информацию о примерных сроках и стоимости доставки.
Установка на сайт.
Разместите код внутри тега <head>
:
1
<script src="https://widgets.saferoute.ru/card/api.js"></script>
Затем разместите код в том месте страницы, где должен располагаться виджет:
1
<div id="saferoute-card-widget"></div>
Запуск виджета.
1
2
3
4
// Инициализация виджета
new SafeRouteCardWidget("saferoute-card-widget", {
apiScript: "/saferoute-widget-api.php"
});
Конструктор SafeRouteCardWidget()
принимает 2 аргумента:
ID DOM-элемента, внутри которого должен инициализироваться виджет;
Объект с параметрами виджета.
Список параметров, которые можно передавать конструктору.
| string | - | Путь к API-скрипту (скачать API-скрипт). |
| string |
| Язык интерфейса виджета: русский (по умолчанию), английский. |
| string | - | КЛАДР населенного пункта пользователя. Если передан, в виджете сразу будет выбран соответствующий населенный пункт. |
| string | - | ФИАС населенного пункта пользователя. Если передан, в виджете сразу будет выбран соответствующий населенный пункт. |
| string | - | Название населенного пункта пользователя (например, «Москва», «Казань»). Наименее предпочтительный способ, рекомендуется использовать КЛАДР и ФИАС. |
| number | >= 0 | Оценочная стоимость. |
| number | >= 0 | Наложенный платеж. |
| number |
| Валюта, в которой будут выведены цены: рубль (по умолчанию), доллар США, евро. Также определяет валюту, в которой передаются |
| number | 0 - 999 | Ширина в см. Дробные значения округляются. Если не задана, берется значение по умолчанию из настроек виджета. |
| number | 0 - 999 | Высота в см. Дробные значения округляются. Если не задана, берется значение по умолчанию из настроек виджета. |
| number | 0 - 999 | Длина в см. Дробные значения округляются. Если не задана, берется значение по умолчанию из настроек виджета. |
| number | 0 - 999 | Вес в кг. Может быть дробным. Если не задан, берется значение по умолчанию из настроек виджета. |
Если виджету не был передан ни kladr
, ни fias
, ни regionName
, он попытается определить населенный пункт по IP-адресу пользователя. В случае, если определить населенный пункт не удалось, пользователю будет предложено указать его самостоятельно.
Расположение настроек виджета.
Чтобы попасть в настройки виджета, зайдите в Личный кабинет SafeRoute, перейдите в раздел «Настройки» > «Магазины». Откройте тот магазин из списка, для которого требуется настроить виджет. На странице магазина нажмите кнопку «Настройки виджетов». В открывшейся панели перейдите в раздел «Карточный виджет».
Использование API-скрипта saferoute-widget-api.php.
Для работы виджета вам необходимо установить на своем сервере наш API-скрипт и прописать путь к этому скрипту в параметре apiScript
виджета.
Скрипт необходим для взаимодействия виджета с сервером SafeRoute и не требует никаких дополнительных настроек, кроме указания в нем вашего токена и ID магазина.
Откройте файл saferoute-widget-api.php
и в строке
1
$widgetApi->setToken('');
вставьте токен, который выводится на странице вашего профиля в Личном кабинете SafeRoute.
А в строке
1
$widgetApi->setShopId('');
вставьте ID магазина со страницы вашего магазина в Личном кабинете SafeRoute.