Download the PHP package aunhurian/nova-poshta-sdk without Composer
On this page you can find all versions of the php package aunhurian/nova-poshta-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aunhurian/nova-poshta-sdk
More information about aunhurian/nova-poshta-sdk
Files in aunhurian/nova-poshta-sdk
Package nova-poshta-sdk
Short Description PHP SDK для інтеграції з API Нової Пошти
License MIT
Homepage https://github.com/aunhurian/nova-poshta-sdk
Informations about the package nova-poshta-sdk
Nova Poshta SDK для PHP
PHP SDK для інтеграції з API Нової Пошти
Вимоги
- PHP 7.4 або вище
- Composer
Встановлення
Або клонуйте репозиторій:
Швидкий старт
Документація API Нової Пошти
Цей SDK базується на офіційному API Нової Пошти. Детальну документацію по API можна знайти за посиланням: Документація API Нової Пошти
Детальна документація SDK
Детальний опис усіх доступних методів та їх параметрів SDK можна знайти в окремому документі: Детальна документація API функцій SDK
Структура SDK
SDK розділений на модулі, кожен з яких відповідає за окрему частину API Нової Пошти:
- AddressApi - Робота з адресами, населеними пунктами, вулицями та відділеннями
- CounterpartyApi - Робота з контрагентами (клієнтами)
- DocumentApi - Створення, редагування та видалення накладних (ТТН)
- TrackingApi - Відстеження статусу посилок
- CommonApi - Отримання довідкової інформації
Детальний опис модулів
AddressApi
CounterpartyApi
DocumentApi
TrackingApi
CommonApi
Клас відповіді API
SDK містить клас NovaPoshtaResponse
для роботи з відповідями API Нової Пошти. За замовчуванням SDK повертає тільки дані з відповіді, але ви можете отримати повний об'єкт відповіді, що містить додаткову інформацію:
Ви також можете використовувати прямий запит до API замість модульних методів:
Внесок у розробку
Ми вітаємо внески від спільноти! Якщо ви хочете покращити SDK:
- Форкніть репозиторій
- Клонуйте його локально
- Внесіть зміни
- Відправте Pull Request
Детальні інструкції щодо внеску у розробку можна знайти у файлі CONTRIBUTING.md.
Тестування
SDK має повний набір тестів для перевірки функціональності. Щоб запустити тести, використовуйте:
Тести організовані за модулями API та використовують мокування HTTP-запитів для симуляції роботи з API Нової Пошти без фактичних мережевих запитів.
Детальний опис системи тестування можна знайти в TESTING.md.
Використання фейкових відповідей у ваших тестах
SDK надає механізм для налаштування фейкових відповідей API для ваших інтеграційних тестів. Це може бути корисно, коли ви хочете протестувати взаємодію вашого додатку з API Нової Пошти без виконання реальних API-запитів.
Система фейкових відповідей підтримує зіставлення параметрів, що дозволяє визначати різні відповіді на основі вхідних параметрів. Це особливо корисно для тестування різних сценаріїв з одним і тим же методом API.
Кожна фейкова відповідь повинна бути структурована наступним чином:
- Використовуйте
'response'
для визначення повної структури відповіді (включаючиsuccess
,data
,errors
і т.д.) - Опціонально використовуйте
'params'
для визначення параметрів, які повинні збігатися для використання цієї фейкової відповіді - Опціонально встановіть
'statusCode'
(за замовчуванням 200), щоб симулювати різні HTTP-статуси
При використанні цієї функції у ваших тестах рекомендується завжди очищати фейкові відповіді після кожного тесту, щоб переконатися, що тести не впливають один на одного.
Винятки
SDK використовує систему виключень для обробки помилок:
NovaPoshtaApiException
- Виключення, що виникає при помилках в API Нової ПоштиNovaPoshtaHttpException
- Виключення, що виникає при HTTP-помилках
Ліцензія
Цей проект ліцензований за ліцензією MIT - дивіться файл LICENSE для деталей.