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