PHPackages                             kitdelivery/sdk-kit-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kitdelivery/sdk-kit-api

ActiveLibrary[API Development](/categories/api)

kitdelivery/sdk-kit-api
=======================

PHP client for KIT API

v1.0.0(3y ago)1611↓50%1BSD-3-ClausePHPPHP ~8.0

Since May 4Pushed 3y ago1 watchersCompare

[ Source](https://github.com/kitdelivery/sdk-kit-api)[ Packagist](https://packagist.org/packages/kitdelivery/sdk-kit-api)[ RSS](/packages/kitdelivery-sdk-kit-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (32)Versions (2)Used By (0)

SDK KIT API PHP
===============

[](#sdk-kit-api-php)

---

Это PHP KIT API клиент. Эта библиотека позволяет использовать актуальную версию API. Вы можете найти больше информации в [документации](https://tk-kit.com/services/api).

Требования
----------

[](#требования)

---

- PHP 7.4 и выше
- поддержка PHP CURL
- поддержка PHP JSON
- Любой HTTP-клиент, совместимый с PSR-18 (см. инструкции по установке).
- Любая реализация HTTP-фабрик, совместимая с PSR-17 (см. инструкции по установке).
- Любая реализация HTTP-сообщений, совместимая с PSR-7 (см. инструкции по установке).
- Другие зависимости, перечисленные в `composer.json` (см. инструкции по установке)

Установка
---------

[](#установка)

---

Выполните следующие шаги, что бы установить библиотеку:

1. Скачайте и установите [Composer](https://getcomposer.org/download/) package manager.
2. composer require "kitdelivery/sdk-kit-api":"\*"

**Примечание:** API клиент использует `php-http/curl-client` и `nyholm/psr7` для реализации PSR-18, PSR-17 и PSR-7. Вы можете заменить эти реализации во время установки, заменив библиотеку на реализацию по вашему выбору.

Использование
-------------

[](#использование)

---

Первое, вы должны инициализировать клиента. Самый простой способ сделать это - использовать `SimpleClientFactory`:

```
$client = \service\KitAPI\Factory\SimpleClientFactory::createClient('https://capi.tk-kit.com', 'token');
```

Клиент разделен на несколько групп, которые доступны через публичные свойства клиента. Вы можете вызывать методы API из этих групп следующим образом:

```
$client->profile->getList();
```

Для примера, вы можете получить список всех городов:

```
$client = \service\KitAPI\Factory\SimpleClientFactory::createClient('https://capi.tk-kit.com', 'token');
$client->tdd->getListCity();
```

или список всех стран:

```
$client = \service\KitAPI\Factory\SimpleClientFactory::createClient('https://capi.tk-kit.com', 'token');
$client->tdd->getListCountry();
```

Для обработки ошибок вы можете использовать два типа исключений:

- `service\KitAPI\Interfaces\ClientExceptionInterface` для ошибок сети и других ошибок.
- `service\KitAPI\Interfaces\ApiExceptionInterface` для ошибок из API.

### Список ресурсных групп и методов

[](#список-ресурсных-групп-и-методов)

---

- [Заказы (order)](doc/order.md)
    - [Расчет стоимости (calculate)](doc/order.md#%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82-%D1%81%D1%82%D0%BE%D0%B8%D0%BC%D0%BE%D1%81%D1%82%D0%B8)
    - [Расчет стоимости посылки (calculatePost)](doc/order.md#%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82-%D1%81%D1%82%D0%BE%D0%B8%D0%BC%D0%BE%D1%81%D1%82%D0%B8-%D0%BF%D0%BE%D1%81%D1%8B%D0%BB%D0%BA%D0%B8)
    - [Создание заказа (create)](doc/order.md#%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5-%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%D0%B0)
    - [Создание заказа на посылку (createPost)](doc/order.md#%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5-%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%D0%B0-%D0%BD%D0%B0-%D0%BF%D0%BE%D1%81%D1%8B%D0%BB%D0%BA%D1%83)
    - [Список заказов (getListOrder)](doc/order.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%D0%BE%D0%B2)
    - [Время доставки (getTimeDelivery)](doc/order.md#%D0%B2%D1%80%D0%B5%D0%BC%D1%8F-%D0%B4%D0%BE%D1%81%D1%82%D0%B0%D0%B2%D0%BA%D0%B8)
    - [Статус заказа (getStatus)](doc/order.md#%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81-%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%D0%B0)
    - [Информация по заказу (getOrder)](doc/order.md#%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%D1%83)
    - [Фото груза по заказу (getPhoto)](doc/order.md#%D1%84%D0%BE%D1%82%D0%BE-%D0%B3%D1%80%D1%83%D0%B7%D0%B0-%D0%BF%D0%BE-%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%D1%83)
    - [Документ груза по заказу (getDocument)](doc/order.md#%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82-%D0%B3%D1%80%D1%83%D0%B7%D0%B0-%D0%BF%D0%BE-%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%D1%83)
    - [Список валют (getListCurrency)](doc/order.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%B2%D0%B0%D0%BB%D1%8E%D1%82)
    - [Список услуг (getListService)](doc/order.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D1%83%D1%81%D0%BB%D1%83%D0%B3)
- [Транспортные маршруты (tdd)](doc/tdd.md#%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%BD%D1%8B%D0%B5-%D0%BC%D0%B0%D1%80%D1%88%D1%80%D1%83%D1%82%D1%8B)
    - [Список городов (getListCity)](doc/tdd.md#c%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%B3%D0%BE%D1%80%D0%BE%D0%B4%D0%BE%D0%B2)
    - [Список стран (getListCountry)](doc/tdd.md#c%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D1%81%D1%82%D1%80%D0%B0%D0%BD)
    - [Список регионов (getListRegion)](doc/tdd.md#c%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D1%80%D0%B5%D0%B3%D0%B8%D0%BE%D0%BD%D0%BE%D0%B2)
    - [Поиск города по имени (searchByName)](doc/tdd.md#%D0%BF%D0%BE%D0%B8%D1%81%D0%BA-%D0%B3%D0%BE%D1%80%D0%BE%D0%B4%D0%B0-%D0%BF%D0%BE-%D0%B8%D0%BC%D0%B5%D0%BD%D0%B8)
    - [Поиск номера КЛАДР или поиск номера города (searchCodeCity)](doc/tdd.md#%D0%BF%D0%BE%D0%B8%D1%81%D0%BA-%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0-%D0%BA%D0%BB%D0%B0%D0%B4%D1%80-%D0%B8%D0%BB%D0%B8-%D0%BF%D0%BE%D0%B8%D1%81%D0%BA-%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0-%D0%B3%D0%BE%D1%80%D0%BE%D0%B4%D0%B0)
- [География (geography)](doc/geography.md)
    - [Список адресов (getListAddress)](doc/geography.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%BE%D0%B2)
    - [Список городов (getListCity)](doc/geography.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%B3%D0%BE%D1%80%D0%BE%D0%B4%D0%BE%D0%B2)
    - [Список электронных адресов (getListEmail)](doc/geography.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D1%8D%D0%BB%D0%B5%D0%BA%D1%82%D1%80%D0%BE%D0%BD%D0%BD%D1%8B%D1%85-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%BE%D0%B2)
    - [Список номеров телефонов (getListPhone)](doc/geography.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%BE%D0%B2-%D1%82%D0%B5%D0%BB%D0%B5%D1%84%D0%BE%D0%BD%D0%BE%D0%B2)
    - [Список режимов работы (getListSchedule)](doc/geography.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D1%80%D0%B5%D0%B6%D0%B8%D0%BC%D0%BE%D0%B2-%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B)
    - [Список видов графиков работы (getListScheduleGroup)](doc/geography.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%B2%D0%B8%D0%B4%D0%BE%D0%B2-%D0%B3%D1%80%D0%B0%D1%84%D0%B8%D0%BA%D0%BE%D0%B2-%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B)
- [Профили (profile)](doc/profile.md)
    - [Регистрация профиля (add)](doc/profile.md#%D1%80%D0%B5%D0%B3%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D1%80%D0%BE%D1%84%D0%B8%D0%BB%D1%8F)
    - [Подтверждение регистрации профиля (confirm)](doc/profile.md#%D0%BF%D0%BE%D0%B4%D1%82%D0%B2%D0%B5%D1%80%D0%B6%D0%B4%D0%B5%D0%BD%D0%B8%D0%B5-%D1%80%D0%B5%D0%B3%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%B8-%D0%BF%D1%80%D0%BE%D1%84%D0%B8%D0%BB%D1%8F)
    - [Список профилей (getList)](doc/profile.md#%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%BF%D1%80%D0%BE%D1%84%D0%B8%D0%BB%D0%B5%D0%B9)

### Примеры

[](#примеры)

---

Получение списка всех стран:

```