Wiki

Clone wiki

vozimby-php-api / Home

Сервер для запросов

API расположено по адресу b2b.vozim.by и работает на базе GET-запросов по протоколу HTTP 1.1.

Почти во всех запросах ответ приходит в формате JSON.

Наименование запроса передается через параметр r, например http://b2b.vozim.by/index.php?r=api/clientLocality

Перечень действующих запросов:

Метод Описание
api/calculationJson запрос на калькуляцию по выбранным параметрам
api/clientLocality список населенных пунктов (см. параметр locality)
api/rulesJson список категорий (см. параметр rule)
api/daybycity даты доставки по коду города (без отклонения)
api/daybylocality даты доставки по населеному пункту (api/clientLocality)
api/cityList список городов для доставки
api/statusJson статус заявки
api/receiptCRU создание и обновление заявки
api/receiptCancel отмена заявки
api/calculationFullJson калькуляция по двум или трем тарифам, вместе с датами доставки

Обработка ошибок

В случае, если это предусмотрено запросом, в ответе приходит статус запроса.

Код статуса Описание
ok Запрос успешно обработан
failed Логическая ошибка в данных
critical Произошла внутренняя ошибка либо исключение, также выдается по несуществующим запросам

Также, если это предусмотрено запросом, существуте код статуса:

  • 200 - ответ соответствует запросу
  • 400 - недостаточно параметров, либо они некорректны
  • 403 - необходима авторизация (либо логин-пароль не подошли)
  • 404 - запращиваемый объект не найден

Аутентификация

Некоторые запросы требуют прохождение аутентификации, а именно:

  • api/statusJson
  • api/receiptCRU
  • api/receiptCancel

Для этого необходимо передавать следующие параметры:

  1. username - имя пользователя (в ЛК)
  2. password_hash - sha256 пароля пользователя (в ЛК)

Разделы документации

Updated