Укр
Створення API-ключа
integration
API

Початок роботи

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

Як створити ключ клієнту з Європи

API-ключі видаються виключно фізичним особам. Щоб використовувати API для бізнес-потреб, необхідно призначити довірену особу-представника компанії та отримати API-ключі на її ім'я або призначити довіреною особою того, у кого вже є ключ.

Дані довіреної особи представника вказуються в договорі з Nova Post.

  1. 1
    Створіть обліковий запис в кабінеті My Nova Post

    Зареєструйтесь на my.novapost.com. Покрокова інструкція з реєстрації 

Під час реєстрації використовуйте номер телефону та електронну пошту довіреної особи, вказаної у договорі. Якщо обліковий запис вже створено — повторна реєстрація не потрібна.

  1. 2
    Створіть API-ключ у кабінеті My Nova Post

    Перейдіть у розділ «Інтеграції → API-ключі» my.novapost.com та створіть ключ для продакшн-середовища.

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

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

Ключ одразу з’явиться у списку з інформацією про: 

  • дату створення
  • назву
  • статус (активний/деактивований)
  • організацію
  • термін дії

Як створити тестовий API-ключ

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

Спосіб 1

На сторінці генерації тестових ключів на порталі Nova Post:

  • Укажіть номер телефону, який зареєстрований у вашому особистому кабінеті my.novapost.com та виконайте запит на створення ключа.
  • Після успішного запиту буде згенеровано тестовий API-ключ для пісочниці (Stage environment), прив’язаний до фізичної особи без зв’язку з організаціями.

Спосіб 2

Згенеруйте тестовий ключ через АПІ. Для цього слідуйте інструкції в документації API Nova Post.

До інструкції 

Як створити ключ клієнту з України

Генерація ключів в Бізнес-кабінеті України у вкладці «Налаштування - Безпека»: пряме посилання на розділ.

  • Покрокова інструкція:

    1. Авторизуйтесь в бізнес-кабінеті new.novaposhta.ua як юридична особа.
    2. Перейдіть в розділ «Налаштування»
    3. Виберіть розділ «Безпека»
    4. Натисніть «Створити ключ»
    5. Ключ створено. Скопіюйте код для використання API Nova Post

Додаткові рекомендації

  • Безпека: Зберігайте ваші API ключі в надійному місці та не розголошуйте їх третім особам.
  • Тестування: Використовуйте тестове середовище для перевірки інтеграції, перш ніж переходити до продакшн-середовища.
  • Контроль доступу: Регулярно перевіряйте список користувачів, які мають доступ до вашого облікового запису та API ключів.