Огляд методів

Розділ Методи містить API-інструменти Nova Post для інтеграції ключових логістичних процесів у зовнішні системи та автоматизації взаємодії з сервісами доставки.

Методи згруповані за основними напрямками інтеграції:

• Авторизація — отримання API-ключів і JWT-токенів для авторизованих запитів;
• Довідники — доступ до довідкових даних для коректного формування API-запитів;
• Сервіси — додаткові методи для роботи з окремими сервісними сценаріями;
• Відправлення — створення, оновлення, розрахунок і керування доставкою;
• Кур'єрська доставка — оформлення та супровід заявок на забір відправлень кур’єром;
• Webhooks — автоматичне отримання подій і статусів через підписки;
• Фулфілмент — управління товарами, складськими залишками, замовленнями та inbound-операціями.

Кожен підрозділ містить опис endpoint-ів, параметри запиту, приклади відповідей і правила використання для побудови інтеграції.

Колекції у Postman

Це набір готових запитів для тестування методів API, який спрощує інтеграцію та усуває потребу створювати запити вручну.

Завантажити

SDK для PHP-застосунків

Це офіційна PHP-бібліотека для інтеграції з API Nova Post, яка надає готові методи для роботи з відправленнями, відстеженням, розрахунками та іншими сервісами Nova Post, підтримуючи сучасні стандарти PHP і гнучкі можливості налаштування.

Почати роботу з SDK

Версіонування API

Опис

Nova Post використовує версіонування API для впровадження значних змін, зберігаючи при цьому стабільність існуючих інтеграцій клієнтів.

Кожна основна версія API публікується окремо в документації API. Коли стає доступною нова основна версія, попередня версія продовжує працювати протягом перехідного періоду, що дозволяє клієнтам спланувати та завершити міграцію без переривання роботи своїх сервісів.

Стратегія Версіонування

Ми використовуємо версіонування на основі URL. Номер версії включається до шляху API endpoint:

• https://api.novapost.com/v1.0/shipments - поточна версія
• https://api.novapost.com/v2.0/shipments - майбутня версія

Коли ми випускаємо нову основну версію, попередня версія переходить у період підтримки. Ваша існуюча інтеграція продовжує працювати без змін, доки ви не будете готові виконати міграцію на нову версію.