Що таке колекції API
Колекція API в Postman — це набір готових запитів до API, які забезпечують зручність тестування методів API. Вони допомагають розробникам інтегруватися з API швидше та ефективніше, оскільки усуває необхідність створення запитів вручну.
Як влаштовані колекції API для Nova Post
- Пісочниця для тестування
Тестуйте API у захищеному середовищі перед повною інтеграцією. Колекція розроблена спеціально для тестового середовища sandbox, що дозволяє клієнтам протестувати API без ризику впливу на продуктивні дані.
URL для тестового середовища: https://api-stage.novapost.com/v.1.0/
Для тестового середовища необхідно отримати окремі API-ключі. Для цього слідуйте інструкції
- Попередньо налаштовані запити
Колекція містить готові до використання методи для основних операцій:
- 1Авторизація: Генерація JWT-токена для доступу до API.
- 2Робота з довідниками: Завантаження переліків міст, відділень, типів відправлень.
- 3Операції з відправленнями: Створення, редагування та відстеження відправлень.
- 4Друк етикеток: Генерація термоетикеток для посилок.
- Автоматизація аутентифікації
Колекція автоматично зберігає отриманий JWT-токен у змінних Postman, що спрощує виконання послідовних запитів.
- Інтегрована документація
Кожен метод в колекції супроводжується вбудованими описами, прикладами використання та поясненнями. Це допомагає розробникам швидко зрозуміти функціональність API.
Приклад відображення опису:
Обмеження: колекція розроблена лише для тестового середовища.
Для роботи в продуктивному середовищі необхідно адаптувати URL та змінні відповідно до документації API.
Як почати роботу з колекцією
- 1
- 2Додайте колекцію до свого Postman:
- 3Налаштуйте змінну apiKey зі своїм тестовим API-ключем, отриманим від Nova Post.
Готово! Використовуйте вбудовані запити для тестування функціональності API.