API-токен
- Доступно на ознайомчому періоді та тарифі Преміум
API-токен — це ключ, яким ваш сайт, CRM чи власна програма підтверджує публічному API IBAN oplata, що запит іде від вашого кабінету. Токен створюється на сторінці API Токен однією кнопкою, не має терміну дії і працює, доки ви його не перегенеруєте або не видалите. У кабінету може бути лише один чинний токен; хто знає токен, той може створювати посилання на оплату від вашого імені, тож зберігайте його в таємниці.
Де знайти сторінку «API Токен»
- На широкому екрані натисніть кнопку з вашою поштою внизу бокової панелі кабінету. Відкриється меню акаунта.
- У меню акаунта оберіть API Token. Відкриється сторінка «API Токен».
- На телефоні відкрийте меню кнопкою в шапці кабінету й оберіть API Токен — відкриється та сама сторінка.
Поки токена немає, сторінка показує «Ви ще не маєте створеного API Токена» і кнопку Згенерувати Токен. Внизу сторінки — адреса API і посилання на документацію Swagger; з чого почати роботу з API, описано в статті Публічне API: з чого почати.
Створити токен
На сторінці API Токен натисніть Згенерувати Токен. У полі Токен зʼявиться новий токен, а поруч — кнопки Перегенерувати і Копіювати.


Натисніть Копіювати (на вузькому екрані — лише іконка без підпису). Токен потрапить у буфер обміну, і зʼявиться повідомлення «Токен скопійовано».
Вставте токен у налаштування своєї інтеграції — туди, де ваша програма зберігає ключі доступу.
Токен довгий, тому копіюйте його кнопкою Копіювати, а не виділенням: у полі видно лише початок токена, і обрізаний токен API не прийме. Повернутися по токен можна будь-коли — сторінка API Токен показує чинний токен щоразу, коли ви її відкриваєте.
Де зберігати API-токен
API-токен дає доступ до посилань і реквізитів вашого кабінету, тому він має лишатися лише на вашому сервері:
- тримайте токен у змінних оточення або в сховищі секретів вашого хостингу чи CRM, а не в коді, який бачать інші;
- не вставляйте токен у код сторінок сайту, який виконується в браузері відвідувача, у мобільний застосунок чи в публічний репозиторій — звідти його може скопіювати будь-хто;
- якщо у вашого сайту немає власного сервера, не намагайтеся звертатися до API з браузера — для такого випадку є динамічні посилання без токена, які налаштовує служба підтримки.
Сторінку API Токен бачить кожен, хто має доступ до вашого кабінету, тож не діліться паролем від кабінету з тими, кому токен знати не потрібно.
Перегенерувати токен
Перегенерація замінює токен на новий без перерви в роботі інтеграції: старий токен ще 12 годин працює паралельно з новим. Так варто робити, коли токен міг потрапити до сторонніх, але інтеграцію зупиняти не можна.
- На сторінці API Токен натисніть Перегенерувати поруч із токеном. Відкриється вікно «Перегенерувати Токен» з попередженням, що старий токен залишатиметься активним ще 12 годин.
- У вікні натисніть Перегенерувати. Вікно закриється, а в полі Токен зʼявиться новий токен.
- Скопіюйте новий токен кнопкою Копіювати і замініть ним старий в усіх місцях, де працює інтеграція, протягом 12 годин.
Кнопка Скасувати у вікні «Перегенерувати Токен» закриває його без змін. Не розраховуйте, що старий токен перестане працювати рівно через 12 годин: API памʼятає перевірені токени, тож старий токен може відповідати ще кілька годин після цього.
Видалити токен
Видалення відключає токен без заміни: інтеграції, які ним користуються, перестануть працювати. Видаляйте токен, коли інтеграція більше не потрібна або коли токен потрапив до сторонніх і перехідний період вам не потрібен.
- На сторінці API Токен натисніть Видалити Токен. Відкриється вікно «Видалити Токен» з попередженням, що видалення призведе до припинення роботи всіх підключень до API.
- У вікні натисніть Видалити Токен. Поле з токеном зникне, сторінка покаже «Ви ще не маєте створеного API Токена» і кнопку Згенерувати Токен.
- Якщо інтеграція ще потрібна, натисніть Згенерувати Токен і вставте новий токен у її налаштування.
API перестає приймати видалений токен не завжди одразу: якщо токеном користувалися протягом останніх 12 годин, API може приймати його ще до 12 годин. Якщо токен потрапив до сторонніх і кожна година має значення, після видалення напишіть у підтримку.
Якщо щось не так
- API відповідає «Передплата закінчилася або ваш тариф не підтримує API-інтеграцію.» Токен створюється на сторінці API Токен, але працює лише на тарифах, вказаних над цією статтею; на інших тарифах API відповідає цією помилкою доступу навіть на правильний токен. Оберіть відповідний тариф на сторінці Мій тариф — доступ зʼявиться протягом пʼяти хвилин.
- Кнопки на сторінці «API Токен» показують «Передплата закінчилася або ваш тариф не включає цей функціонал.» Створювати, перегенеровувати й видаляти токен можна, поки триває платний або ознайомчий період, і ще кілька днів після його закінчення. Пізніше кабінет відмовляє, хоча чинний токен на сторінці видно. Поновіть передплату на сторінці Мій тариф.
- Зʼявляється «Токен уже згенеровано. Щоб згенерувати новий токен, деактивуйте наявний.» Токен уже створено, наприклад в іншій вкладці браузера. Оновіть сторінку API Токен — на ній буде чинний токен; новий отримайте кнопкою Перегенерувати.
- API не приймає токен, хоча тариф підходить. Токен скопійовано не повністю, токен видалено, або його перегенерували понад 12 годин тому і в інтеграції лишився старий. Скопіюйте чинний токен зі сторінки API Токен кнопкою Копіювати.
- Після копіювання зʼявляється «Помилка копіювання». Браузер не дав сторінці записати текст у буфер обміну. Натисніть Копіювати ще раз або відкрийте кабінет в іншому браузері.