Skip to content
ISeeWhatYouDidHere edited this page Apr 10, 2019 · 10 revisions

SDK преследует две цели:

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

SDK состоит трех частей, первые две реализуют доступ ко всем Public и Shipping методам Api Shiptor, а третья содержит вспомогательные функции.

Минимальные требования

  • PHP 5.5+, 7.0
  • guzzlehttp/guzzle 5.1+

Установка

Установить SDK можно используя composer

composer require shiptor-russia/api-client

Если composer пишет что у него не получилось найти пакет при ваших настройках стабильности вы можете обойти ограничения указав напрямую

composer require "shiptor-russia/api-client @dev"

Информация о SDK

Методы API Shiptor разбиты на два основных раздела.

Публичный раздел или Public содержит методы, доступные любому пользователю. Они предоставляют возможность рассчитать приблизительную стоимость доставки, получить список всех населенных пунктов, список ПВЗ/постаматов, список праздничных и выходных дней, выполнить поиск по базе местоположений с указанием части названия населенного пункта или отследить отправление по его трек номеру.

Приватный раздел или Shipping содержит методы, доступные только зарегистрированному пользователю личного кабинета Shiptor. Эти методы предназначены для работы с отправлениями и отгрузками, и всем связанным с ними. Среди этих методов присутствуют все методы из Public (за исключением getDaysOff). Для доступа к этим методам потребуется специальный API ключ, выдаваемый при регистрации в Shiptor и заключения договора.

You can’t perform that action at this time.