Download the PHP package kitdelivery/sdk-kit-api without Composer

SDK KIT API PHP

Это PHP KIT API клиент. Эта библиотека позволяет использовать актуальную версию API. Вы можете найти больше информации в документации.

Требования

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

Установка

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

1. Скачайте и установите Composer package manager.
2. composer require "kitdelivery/sdk-kit-api":"*"

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

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

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

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

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

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

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

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

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

• Заказы (order)
  • Расчет стоимости (calculate)
  • Расчет стоимости посылки (calculatePost)
  • Создание заказа (create)
  • Создание заказа на посылку (createPost)
  • Список заказов (getListOrder)
  • Время доставки (getTimeDelivery)
  • Статус заказа (getStatus)
  • Информация по заказу (getOrder)
  • Фото груза по заказу (getPhoto)
  • Документ груза по заказу (getDocument)
  • Список валют (getListCurrency)
  • Список услуг (getListService)
• Транспортные маршруты (tdd)
  • Список городов (getListCity)
  • Список стран (getListCountry)
  • Список регионов (getListRegion)
  • Поиск города по имени (searchByName)
  • Поиск номера КЛАДР или поиск номера города (searchCodeCity)
• География (geography)
  • Список адресов (getListAddress)
  • Список городов (getListCity)
  • Список электронных адресов (getListEmail)
  • Список номеров телефонов (getListPhone)
  • Список режимов работы (getListSchedule)
  • Список видов графиков работы (getListScheduleGroup)
• Профили (profile)
  • Регистрация профиля (add)
  • Подтверждение регистрации профиля (confirm)
  • Список профилей (getList)

Примеры

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

Вывод терминалов для города c id = 699:

Расчет стоимости доставки груза:

Обработка ошибок в приведенных выше примерах хороша для реального использования в проектах. Вы можете с уверенностью сказать, ApiExceptionInterface - это ошибка API, а ClientExceptionInterface - ошибка клиента. (например, сетевая ошибка или любая ошибка времени выполнения, используйте HttpClientException, чтобы перехватывать только ошибки клиента PSR-18). При желании вы можете реализовать свою обработку ошибок.

Так же, ApiExceptionInterface и ClientExceptionInterface реализуют магический метод __toString(). Это означает, что вы можете просто преобразовать эти исключения в строку и поместить их в журнал логов без какой-либо обработки.