Skip to content
This repository has been archived by the owner. It is now read-only.
gordlashan edited this page Apr 30, 2020 · 13 revisions
Clone this wiki locally

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 разбиты на два основных раздела:

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

  2. Приватный раздел или Shipping содержит методы, доступные только пользователям, которые зарегистрирован в Shiptor. Они предназначены для работы с отправлениями, отгрузками и всем, что с ними связано. Для доступа к этим методам потребуется специальный API-ключ, выдаваемый при регистрации в Shiptor и заключении договора.