> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/novaposhta-docs/ua/kroki-integraciyi/stvorennya-api-klyucha.md).

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

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

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

1. **Створіть обліковий запис** [в кабінеті My Nova Post](https://new.novaposhta.ua/)

Зареєструйтесь на my.novapost.com. [Покрокова інструкція з реєстрації](https://novapost.com/uk-pl/my-nova-post-instructions#registration)[ ](https://api-portal-stage.novapost.com/uk/my-nova-post-instructions#registration)

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

Перейдіть у розділ «Інтеграції → API-ключі» в кабінеті My Nova Post та натисніть «Створити API-ключ».

Під час створення ключа заповніть необхідні параметри:

**Назва API-ключа**

Вкажіть назву, за якою ви зможете легко ідентифікувати ключ у списку створених API-ключів, наприклад: `Production`, `Online store` або `CRM integration`.

> Поле є необов’язковим.

**E-mail для сповіщень**

Вкажіть e-mail відповідальної особи, яка має отримувати важливі сповіщення щодо API-ключа, зокрема нагадування про завершення строку його дії та інші повідомлення, пов’язані з використанням ключа.

> Поле є необов’язковим.

Після створення API-ключа на вказану e-mail адресу буде надіслано лист для її підтвердження. Перейдіть за посиланням у листі та підтвердьте адресу відповідно до отриманих інструкцій.

**Організації**

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

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

Після заповнення параметрів натисніть «Створити API-ключ».

<figure><img src="https://2345803808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjHxCKEoroCNtyMJv9SHO%2Fuploads%2F5NjTtAoy2jVagERVVNts%2Fimage.png?alt=media&amp;token=e13a9804-d916-43f0-a95b-72341d6f7fd3" alt=""><figcaption></figcaption></figure>

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

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

#### **Створення тестового API-ключа — спосіб 1**

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

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

**Спосіб 2**

## Створити або продовжити тестовий API-ключ (лишеSandbox)

> Публічний метод, доступний лише в непродуктивних середовищах (Sandbox), для створення або продовження тестового API-ключа для клієнта, ідентифікованого за номером телефону.\
> \
> Вимоги:\
> \- Номер телефону має бути зареєстрований у Клієнтському порталі (EBC): <https://my.novapost.com/> \
> \- Генерація ключів для України наразі не підтримується\
> \
> Поведінка: \
> \- Якщо ключ вже існує та має статус Active, повторний виклик протягом того самого дня поверне той самий ключ \
> \- Якщо строк дії ключа закінчився, його буде повторно активовано з новою датою закінчення дії \
> \- Якщо ключ було видалено під час очищення, буде створено новий ключ \
> \- Для одного номера телефону дозволено лише один активний ключ і не більше одного запиту на день\
> \
> Наступний крок: \
> Після отримання apiKey необхідно згенерувати тимчасовий JWT, викликавши \[GET /clients/authorization]\(<https://api-portal.novapost.com/novaposhta-docs/integration-guide/how-to-generate-a-jwt-token>). JWT є обов’язковим для всіх авторизованих запитів. \
> Вставте jwt у діалогове вікно \*\*\[Authorize]\(<https://api.novapost.com/developers/index.html#auth)\\*\\>\* у схемі \`JWT\` у цій документації, щоб активувати функцію Try-it-out.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Authorization"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[],"paths":{"/test-api-keys":{"post":{"tags":["Authorization"],"summary":"Створити або продовжити тестовий API-ключ (лишеSandbox)","description":"Публічний метод, доступний лише в непродуктивних середовищах (Sandbox), для створення або продовження тестового API-ключа для клієнта, ідентифікованого за номером телефону.\n\nВимоги:\n- Номер телефону має бути зареєстрований у Клієнтському порталі (EBC): https://my.novapost.com/ \n- Генерація ключів для України наразі не підтримується\n\nПоведінка: \n- Якщо ключ вже існує та має статус Active, повторний виклик протягом того самого дня поверне той самий ключ \n- Якщо строк дії ключа закінчився, його буде повторно активовано з новою датою закінчення дії \n- Якщо ключ було видалено під час очищення, буде створено новий ключ \n- Для одного номера телефону дозволено лише один активний ключ і не більше одного запиту на день\n\nНаступний крок: \nПісля отримання apiKey необхідно згенерувати тимчасовий JWT, викликавши [GET /clients/authorization](https://api-portal.novapost.com/novaposhta-docs/integration-guide/how-to-generate-a-jwt-token). JWT є обов’язковим для всіх авторизованих запитів. \nВставте jwt у діалогове вікно **[Authorize](https://api.novapost.com/developers/index.html#auth)** у схемі `JWT` у цій документації, щоб активувати функцію Try-it-out.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["phone"],"properties":{"phone":{"type":"string","description":"Номер телефону, зареєстрований в EBC. Формат: 49XXXXXXXXX (без символу '+'). Генерація ключів для України наразі не підтримується.\n"}}}}}},"responses":{"200":{"description":"Тестовий API-ключ створено або повернуто","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestApiKeyResponse"}}}},"400":{"description":"Помилка валідації","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Клієнта не знайдено в EBC","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"В EBC знайдено кілька клієнтів, що відповідають критеріям пошуку","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Перевищено денний ліміт для цього користувача (один запит на день)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"$ref":"#/components/responses/Time-out"}}}}},"components":{"schemas":{"TestApiKeyResponse":{"type":"object","additionalProperties":false,"required":["apiKey","createdAt","expDate","status"],"properties":{"apiKey":{"type":"string","description":"Test API key for Stage usage only."},"createdAt":{"type":"string","format":"date-time"},"expDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["Active","Expired"]}}},"ErrorResponse":{"type":"object","additionalProperties":false,"required":["success","errors"],"properties":{"success":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"}}}},"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}},"responses":{"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

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

Генерація ключів в Бізнес - кабінеті України у вкладці [«Налаштування - Безпека».](https://new.novaposhta.ua/dashboard/settings/developers)

{% stepper %}
{% step %}
Авторизуйтесь в бізнес - кабінеті як юридична особа

<figure><img src="https://2345803808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjHxCKEoroCNtyMJv9SHO%2Fuploads%2F8B46S27R0CrIVf0AWsXk%2Fed18e9b6-2c8c-4907-a01c-967f57a6670b.jpg?alt=media&amp;token=7b4b5f9c-3cf2-470a-8c81-91a3dfecface" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Перейдіть в розділ "Налаштування"

<figure><img src="https://2345803808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjHxCKEoroCNtyMJv9SHO%2Fuploads%2FIDMhzO3jbAYczfOiskJP%2Fcc19565f-3d44-4b71-abb4-2562924238b3.jpg?alt=media&amp;token=9d5f7964-f1de-4288-a33e-0341b7b1ff32" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Виберіть розділ "Безпека"

<figure><img src="https://2345803808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjHxCKEoroCNtyMJv9SHO%2Fuploads%2FunXT7ANeJGsKQTVZ3Xmc%2F580000fd-f648-4850-ad1e-50c4ad8e16b9.jpg?alt=media&amp;token=0fc8da66-86cc-4365-bcc0-03295723d66b" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Натисніть "Створити ключ"

<figure><img src="https://2345803808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjHxCKEoroCNtyMJv9SHO%2Fuploads%2FSpx3TUfupOBE2gWlzspq%2F324dad81-c1dc-4995-92ec-7233453b5f9e.jpg?alt=media&amp;token=8af67c92-d478-47e6-8dd2-fea66057af41" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Ключ створено. Скопіюйте код для використання API Nova Post.

<figure><img src="https://2345803808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjHxCKEoroCNtyMJv9SHO%2Fuploads%2F1HrEH0pb2hOTk8K7z9Z8%2Fa3b6f403-aa29-4e95-86c2-68526fdd76c6.jpg?alt=media&amp;token=2281824e-3b15-491a-a090-f81999b59c6e" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

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

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://api-portal.novapost.com/novaposhta-docs/ua/kroki-integraciyi/stvorennya-api-klyucha.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
