Разработчикам

Описание API

Варианты данных API
Параметры
Результат
Пример JSON / JSON
Пример через GET запрос
API получения списка городов
Пример обработки данных
Встроенный калькулятор
Встроенный калькулятор со списком городов

Транспортная компания «ШЕРЛ» предлагает простой, эффективный и доступный программный интерфейс формата API, с помощью которого Вы сможете создать на своем ресурсе онлайн-сервисы по расчету предварительной стоимости доставки и отслеживанию местоположения груза. Предлагаемое нами решение представляет собой набор готовых инструментов, которые легко интегрируются в различные системы управления сайтом и делают техническое взаимодействие с потенциальными клиентами максимально эффективным.

Преимущества использования нашего решения

• Предлагаемый нами API-инструмент прекрасно подойдет для любого интернет-магазина или компании, которые продают товары с доставкой по городам РФ.
• Интеграция калькулятора позволит Вашим клиентам получать всю необходимую информацию о доставке в режиме реального времени.
• Автоматическая работа сервиса исключает ручную обработку данных, что позволяет оптимизировать и ускорить важные бизнес-процессы.
• Простая настройка и изменение основных параметров: даты доставки, пункта назначения, интервала, веса, цен и прочего.
• Повышение привлекательности услуг и престижности компании перед потенциальными заказчиками и деловыми партнерами.

Порядок интеграции онлайн-калькулятора на сайт

1. Скачать API со страницы www.sherl.ru/api/sherl.php или взять готовый HTML-код калькулятора.
2. Разместить программную конструкцию на своем сайте в месте, где будет располагаться сервис.
3. Задать формат запросов отправки и получения данных (GET, POST или JSON).
4. Ввести и настроить основные параметры расчета (города, вес, объем, дополнительные опции).
5. Изменить размеры и внешний вид в соответствии с дизайном Вашего сайта.

API калькулятора расчета доставки

Предлагаемый нами интерфейс API работает поверх HTTP и доступен для специалистов, имеющих базовые навыки программирования и работы с данным протоколом.

1) Варианты данных API

Отправка и получение данных с нашего сервера осуществляется с помощью GET-, POST- или JSON-запросов. Чтобы выбрать подходящий формат, используйте такие варианты параметра formdata:

• Адрес: www.sherl.ru/api/sherl.php?formdata=jsjs - принимает json / отдаёт json
• Адрес: www.sherl.ru/api/sherl.php?formdata=jsar - принимает json / отдаёт base64_decode массив
• Адрес: www.sherl.ru/api/sherl.php?formdata=arar - принимает GET массив / отдаёт base64_decode массив
• Адрес: www.sherl.ru/api/sherl.php?formdata=arjs - принимает GET массив / отдаёт json
• Адрес: www.sherl.ru/api/sherl.php?formdata=psjs - принимает POST массив / отдаёт json
• Адрес: www.sherl.ru/api/sherl.php?formdata=psar - принимает POST массив / отдаёт base64_decode массив

Чтобы пользователь смог произвести на калькуляторе необходимые расчеты, нужно сделать настройку всех полей массива.

3) Результат

При расчете сначала повторяются введенные данные и по необходимости отдается переменная с вводным словом ["textin"].

Далее внутри вложенного массива ["variant"] идет перечисление полученных данных:

При возникновении ситуации с ошибкой выводится переменная ["text"] или ["error"].

4) Примеры с разными типами запросов

JSON/JSON

Для запроса вида:

Будет выведен результат представленный ниже.

Отдаётся результат в зависимости от вида кодирования:

Если расшифруем, то получим массив

GET (аналогично для POST):

Для запроса вида:

Будет выведен результат представленный ниже.

5) API для получения списка городов

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

Для получения подсказки по городам осуществляется отправка запросов по таким адресам:

1. http://www.sherl.ru/api/from.php?formdata=ar – для города отправления (форма from);

2. http://www.sherl.ru/api/to.php?formdata=ar – для города прибытия груза (форма to).

Готовая для вставки конструкция будет выглядеть так:

Обработка данных в этом случае ведется следующим образом:

Встроенный через iframe калькулятор

Если параметры сайта не позволяет использовать API, создать онлайн-калькулятор можно с помощью специальной конструкции, встроенной через iframe.

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

В результате у Вас получится калькулятор с такой формой расчета:

Также Вы можете установить на сайт калькулятор с выпадающим списком городов:

Результат будет выглядеть так:

Если у Вас есть замечания, предложения или вопросы по интеграции API в структуру веб-ресурса, Вы всегда можете обратиться к нам, отправив сообщение на info@msk.sherl.ru.