Интеграция виджета выбора пункта выдачи

Для использования модуля Boxberry необходимо:
1. Стать клиентом Boxberry (Вы можете самостоятельно пройти регистрацию
http://account.boxberry.ru).
2. Получить уникальный ключ (API-token).
3. Обязательно выбрать пункт приема в разделе Информация о магазине, прямая ссылка:
https://account.boxberry.ru/client/profile/index?tab=store-info 

Описание алгоритма работы виджета

На Вашем сайте или приложении в нужном Вам месте устанавливается дополнительная «кнопка», например, «Доставка Boxberry», при выборе которой Ваш пользователь попадает на специально разработанный интерфейс по выбору удобной для него точки доставки. Выбор может осуществляться по карте города или по выпадающему списку городов, а также по списку станций метро. Пример размещения можно увидеть по ссылке: http://points.boxberry.ru/demo/

Формат передаваемых и получаемых параметров виджета

Информация о выбранном пункте выдачи возвращается в виде объекта result со следующими параметрами:

При инициализации виджета возможны следующие входные параметры:

Последовательность аргументов инициализации виджета:
boxberry.open(‘callback_function’,‘api_token’,‘custom_city’,’target_start’,’ordersum’,’weight’,’paysum’,’height’,’width’,’depth’);

Пример инициализации виджета:
boxberry.open(‘callback_function’,'m2FltAKjbXQBLa2xqZ4sPQ==','Москва','', '1000', '500', '0', '50', '50', '50');

В результате выполнения указанной функции, виджет инициируется следующим образом:
1. По ключу api_token (m2FltAKjbXQBLa2xqZ4sPQ==) загрузятся индивидуальные настройки отображаемых ПВЗ на карте и параметров расчета из ЛК ИМ.
2. Если передан параметр custom_city, откроется карта региона переданного города (в примере Москва).
3. Для расчета стоимости и периода доставки будут использованы параметры:
ordersum (в примере 1000) – стоимость заказа в вашем ИМ (руб.)
weight (в примере 500) – вес товаров в заказе (грамм)
paysum (в примере 0) – сумма к оплате при получении посылки. Если заказ
предоплачен, то передаем 0 рублей, если посылка с наложенным платежом, то
передаем полную стоимость товара (в указанном примере это было бы 1000 рублей)
height (в примере 50) – высота коробки заказа (см)
width (в примере 50) – ширина коробки заказа (см)
depth (в примере 50) – глубина коробки заказа (см)

Техническое описание по установке

1. Необходимо подключить следующий скрипт: http://points.boxberry.de/js/boxberry.js Для сайтов, работающих по https протоколу, необходимо подключить следующий скрипт: https://points.boxberry.de/js/boxberry.js
2. Затем в нужном месте на сайте магазина Вам необходимо поставить ссылку: Выбрать ПВЗ, по событию «onclick» которой должна вызываться функция «boxberry.open» из подключенного ранее файла. В эту функцию обязательно должен передаться параметр «callback_function», который и будет принимать массив с выбранным ПВЗ. 
3. «callback_function» - это название javascript – функции, которая должна быть прописана на странице оформления заказа. Её имя может быть любым, главное, чтобы она была передана в качестве параметра в «boxberry.open». 
4. При нажатии на кнопку "Выбрать отделение" на сайте вызывается функция «callback_function», куда в качестве параметра передается объект с ключами, описанными в таблице 2. Формат данных в возвращенном объекте — строки. 
5. Для работы в режиме ИнфоВиджета – без кнопки «Выбрать отделение», необходимо вызывать виджет без передачи в функцию boxberry.open каких-либо параметров. То есть строка инициализации виджета будет выглядеть примерно так: Выбрать пункт выдачи на карте 
6. Если Вы хотите задать высоту отступа окна виджета относительно верхней части экрана самостоятельно, то используйте метод boxberry.displaySettings(). Например, boxberry.displaySettings({top:10}), где 10 - размер в пикселях. 
7. Для фильтрации отображения ПВЗ с ограничением по максимальному весу существует возможность передавать вес массивом в граммах. Если вес передан числом, то фильтрации ПВЗ не происходит.

Строка вызова виджета для проверки: boxberry.open(callback_function,'gfgiLAIqtr8qn4kciPkUmw==','Екатеринбург' ,'', 574, [100,200,300,30000], 0, 0, 200, 200, 200 ); - мы увидим только те ПВЗ, которые могут принять 30 кг, а стоимость посчитается для веса 30 кг 600 гр.

Для корректной работы виджета в браузере Safari:

1. Сайт должен использовать протокол https.
2. Название callback – функции (выше «callback_function») должно содержать в себе «function». Например, «bb_pvz_function» (а не «bb_pvz»). 

Пример интеграции виджета

На странице http://points.boxberry.ru/demo/ показан пример оформления ссылки вызова виджета и того, как установить ID ПВЗ вскрытое поле для дальнейшей обработки на стороне сервера и как показать пользователю адрес ПВЗ (рекомендуется всегда выводить эту информацию, чтобы пользователь мог видеть адрес выбранной точки и понимать, что его выбор успешно зафиксирован).
На странице http://points.boxberry.ru/demo/on_page.html показан пример оформления виджета для работы непосредственно на странице Вашего сайта.

Подробное описание настроек виджета.

В личном кабинете ИМ Вам доступен раздел «Настройка виджетов», где можно настроить:

1. Настройки отображения ПВЗ на карте виджета.
2. Настройка параметров расчета доставки.

Прямая ссылка на раздел Личного Кабинета «Настройка виджетов» (требуется авторизация в ЛК)
http://account.boxberry.ru/client/infoblock/index?tab=api&api=settings#
Здесь можно найти персональный ключ интеграции виджета.

Настройки отображения пунктов выдачи дают возможность скрыть ПВ по следующим признакам:

1. Не отображать отделения, которые работают только по предоплате – отключает
   отображение на карте отделений, которые работают только по предоплате;
2. Не отображать все отделения в городах – отключает отображения на карте всех ПВ
   выбранного города/страны;
3. Не отображать отделения – отключение отображения на карте конкретного выбранного
   ПВ. Для отображения отделений (в правом блоке) необходимо нажать на город, отделения
   которого необходимо загрузить.

Настройка параметров расчета доставки:

Для активации индивидуальных настроек расчета установите галочку «Включить настройки
расчета»

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

• Округление до – параметр позволяет задать округление стоимости доставки до заданного
  параметра (рубли, десятки рублей или сотни рублей).
• Округлить как – параметр задает формат округления: математическое округление, либо
  всегда в большую сторону.
• Надбавки – параметр позволяет задать надбавку (+ или -).
  Возможны варианты:
  - Надбавка веса на передаваемый вес для расчета стоимости доставки (в граммах);
  - Надбавка на рассчитанную стоимость доставки на процент от (тарифа Boxberry,
  объявленной стоимости, суммы к оплате);
  - Надбавка фиксированной суммы к основной рассчитанной стоимости доставки.
• Стоимость посылок – возможность назначить фиксированную стоимость доставки (в том
  числе и 0) в зависимости от стоимости посылки. В двух диапазонах: от 0 до указанной
  стоимости рублей. И второй диапазон от указанной стоимости до бесконечности.
  * Как вариант, при заданном диапазоне стоимости посылки от 0 до хххх рублей фиксированная стоимость
  доставки всегда составляла, например, 300 рублей, все посылки свыше хххх рублей будут доставляться по
  тарифам boxberry (с учетом остальных настроек). Возможна обратная ситуация, когда стоимость доставки при
  стоимости посылки до указанной суммы считались по тарифам boxberry (с учетом остальных настроек), а
  свыше по фиксированной стоимости, например 0 рублей.
• Опции – возможность задать фиксированный минимальный и максимальный порог
  стоимости доставки, при достижении которого стоимость доставки не может быть меньше
  или больше указанного значения.
  Дополнительные настройки:
• Скрыть срок доставки – возможность отключить отображение срока доставки.
• Укажите количество дней, которое необходимо добавить к основному сроку доставки
  Boxberry – возможность добавить указанное количество дней к основному сроку доставки.

Типы пунктов выдачи: