API калькулятор
API URL:
Параметры API
| Параметр |
Тип |
Значение |
| method |
String |
Возможные значения:
- api_calc — Расчёт стоимости перевозки грузов
- api_city — Получение списка городов
|
|
responseFormat
|
String
|
Возможные значения:
- xml — Выгрузка данных в формате xml
- json — Выгрузка данных в формате json
|
Методы, доступные API
Метод api_calc.
Таблица 1. Обязательные параметры, передаваемые в API
| Параметр |
Тип |
Значение |
| depPoint |
Integer |
Код города отправления |
| arrPoint |
Integer |
Код города назначения |
| cargoKg |
Array |
Вес (кг) |
| cargoMest |
Array |
Кол-во мест |
| cargoL |
Array |
Длина груза (м) |
| cargoW |
Array |
Ширина груза (м) |
| cargoH |
Array |
Высота груза (м) |
| cargoCalculation |
Array |
Возможные значения:
- 0 — вес, длина, ширина и высота указаны для всех мест.
- 1 — вес, длина, ширина и высота указаны для одного места, общие габариты рассчитываются перемножением количества мест на габариты одного места.
|
Таблица 2. Необязательные параметры, передаваемые в API
| Параметр |
Тип |
Значение |
| insure |
Integer |
Оценочная стоимость (руб.) |
| depDoor |
Integer |
Забрать груз от двери |
| arrDoor |
Integer |
Доставить груз до двери |
| depKm |
Integer |
Выезд в км за пределы города при заборе груза |
| arrKm |
Integer |
Выезд в км за пределы города при доставке груза |
| cargoPackBag |
Array |
Упаковка в мешок с пломбой |
| CargoPackHard |
Array |
Жесткая упаковка |
| cargoPackPallet |
Array |
Паллетизация груза |
Таблица 3. Результат обращения к API
| Параметр |
Тип |
Значение |
| price |
Integer |
Рассчитанная стоимость |
| status |
String |
Возможные значения:
- OK — расчёт произведен без ошибок
- ERROR — расчёт с ошибками
|
| error |
Array |
Возможные значения:
- 1 — не указана информация о грузе
- 2 — не указан город отправления
- 3 — не указан город назначения
- 4 — отсутствует тариф для расчета между указанными населёнными пунктами
- 5 — ошибка передачи данных
|
Пример.
Требуется перевезти из Москвы в Санкт Петербург 8 одинаковых коробок, вес каждой коробки — 5 кг, длина коробки — 1.2 м, ширина — 1.1 м, высота — 1.5 м и 5 коробок общим весом 30 кг, общей длиной 10 м, шириной 1 м, высотой 0.8 м. Оценочная стоимость всего груза — 350 тыс. рублей. Требуется упаковать 8 коробок в жёсткую упаковку, а для остальных 5 коробок произвести паллетизацию. Представим информацию о перевозимых коробках в таблице 4.
Таблица 4. Информация о перевозимых коробках
| Груз |
Кол-во мест |
Вес |
Длина |
Ширина |
Высота |
Итоговый вес |
Итоговый объём |
| №1* |
8 |
5 |
1.2 |
1.1 |
1.5 |
40 |
15.84 |
| №2** |
5 |
30 |
10 |
1 |
0.8 |
30 |
8 |
* Указаны габариты и вес одной коробки
** Указаны общие габариты и вес всех коробок
Таблица 5. Параметры URL
| Описание |
Параметр для URL |
| Город отправления |
depPoint=35 |
| Город назначения |
arrPoint=36 |
| Забрать груз от двери |
depDoor=1 |
| Доставить груз до двери |
arrDoor=1 |
| Страхование груза |
insure=350000 |
| Информация о грузе №1 |
|
| Количество мест |
cargoMest[1]=8 |
| Вес (кг) |
cargoKg[1]=5 |
| Длина груза (м) |
cargoL[1]=1.2 |
| Ширина груза (м) |
cargoW[1]=1.1 |
| Высота груза (м) |
cargoH[1]=1.5 |
| Жесткая упаковка |
cargoPackHard[1]=1 |
| |
cargoCalculation[1]=1 |
| Информация о грузе №2 |
|
| Кол-во мест |
cargoMest[2]=5 |
| Вес (кг) |
cargoKg[2]=30 |
| Длина груза (м) |
cargoL[2]=10 |
| Ширина груза (м) |
cargoW[2]=1 |
| Высота груза (м) |
cargoH[2]=0.8 |
| Паллетизация груза |
cargoPackPallet[2]=1 |
| |
cargoCalculation[2]=0 |
Составим итоговый URL:
/api/calc/?method=api_calc&responseFormat=xml&depPoint=35&arrPoint=36&depDoor=1&arrDoor=1&cargoMest[1]=8&cargoKg[1]=5&cargoL[1]=1.2&cargoW[1]=1.1&cargoH[1]=1.5&cargoCalculation[1]=1&cargoPackHard[1]=1&cargoMest[2]=5&cargoKg[2]=30&cargoL[2]=10&cargoW[2]=1&cargoH[2]=0.8&cargoCalculation[2]=0&cargoPackPallet[2]=1&insure=350000
Метод api_city.
/api/calc/?responseFormat=xml&method=api_city — скрипт, возвращающий в выбранном формате список городов. Пожалуйста, кэшируйте справочник городов. Обновлять его достаточно один раз в сутки.
