IBAN oplata Довідка

API-токен

API-токен — це ключ, яким ваш сайт, CRM чи власна програма підтверджує публічному API IBAN oplata, що запит іде від вашого кабінету. Токен створюється на сторінці API Токен однією кнопкою, не має терміну дії і працює, доки ви його не перегенеруєте або не видалите. У кабінету може бути лише один чинний токен; хто знає токен, той може створювати посилання на оплату від вашого імені, тож зберігайте його в таємниці.

Де знайти сторінку «API Токен»

  1. На широкому екрані натисніть кнопку з вашою поштою внизу бокової панелі кабінету. Відкриється меню акаунта.
  2. У меню акаунта оберіть API Token. Відкриється сторінка «API Токен».
  3. На телефоні відкрийте меню кнопкою в шапці кабінету й оберіть API Токен — відкриється та сама сторінка.

Поки токена немає, сторінка показує «Ви ще не маєте створеного API Токена» і кнопку Згенерувати Токен. Внизу сторінки — адреса API і посилання на документацію Swagger; з чого почати роботу з API, описано в статті Публічне API: з чого почати.

Створити токен

  1. На сторінці API Токен натисніть Згенерувати Токен. У полі Токен зʼявиться новий токен, а поруч — кнопки Перегенерувати і Копіювати.

    Сторінка «API Токен»: поле «Токен» зі згенерованим токеном, кнопки «Перегенерувати», «Копіювати» і «Видалити Токен», нижче — адреса API і посилання на документацію Swagger
    Сторінка «API Токен»: поле «Токен» зі згенерованим токеном, кнопки «Перегенерувати», «Копіювати» і «Видалити Токен», нижче — адреса API і посилання на документацію Swagger
  2. Натисніть Копіювати (на вузькому екрані — лише іконка без підпису). Токен потрапить у буфер обміну, і зʼявиться повідомлення «Токен скопійовано».

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

Токен довгий, тому копіюйте його кнопкою Копіювати, а не виділенням: у полі видно лише початок токена, і обрізаний токен API не прийме. Повернутися по токен можна будь-коли — сторінка API Токен показує чинний токен щоразу, коли ви її відкриваєте.

Де зберігати API-токен

API-токен дає доступ до посилань і реквізитів вашого кабінету, тому він має лишатися лише на вашому сервері:

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

Перегенерувати токен

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

  1. На сторінці API Токен натисніть Перегенерувати поруч із токеном. Відкриється вікно «Перегенерувати Токен» з попередженням, що старий токен залишатиметься активним ще 12 годин.
  2. У вікні натисніть Перегенерувати. Вікно закриється, а в полі Токен зʼявиться новий токен.
  3. Скопіюйте новий токен кнопкою Копіювати і замініть ним старий в усіх місцях, де працює інтеграція, протягом 12 годин.

Кнопка Скасувати у вікні «Перегенерувати Токен» закриває його без змін. Не розраховуйте, що старий токен перестане працювати рівно через 12 годин: API памʼятає перевірені токени, тож старий токен може відповідати ще кілька годин після цього.

Видалити токен

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

  1. На сторінці API Токен натисніть Видалити Токен. Відкриється вікно «Видалити Токен» з попередженням, що видалення призведе до припинення роботи всіх підключень до API.
  2. У вікні натисніть Видалити Токен. Поле з токеном зникне, сторінка покаже «Ви ще не маєте створеного API Токена» і кнопку Згенерувати Токен.
  3. Якщо інтеграція ще потрібна, натисніть Згенерувати Токен і вставте новий токен у її налаштування.

API перестає приймати видалений токен не завжди одразу: якщо токеном користувалися протягом останніх 12 годин, API може приймати його ще до 12 годин. Якщо токен потрапив до сторонніх і кожна година має значення, після видалення напишіть у підтримку.

Якщо щось не так