Публічне API: з чого почати
- Доступно на ознайомчому періоді та тарифі Преміум
Публічне API дозволяє вашому сайту, CRM чи обліковій програмі створювати посилання на оплату без кабінету: програма надсилає реквізити, суму й призначення платежу і отримує у відповідь готове посилання на сторінку оплати. API працює за адресою https://api.ibanoplata.com, повний опис запитів — у документації Swagger https://api.ibanoplata.com/swagger. Щоб почати, потрібен API-токен з кабінету і тариф, на якому API доступне.
Що вміє API
- Створити посилання на оплату з фіксованою сумою. Ви передаєте юридичну назву отримувача, ЄДРПОУ або РНОКПП, IBAN, суму, призначення платежу і за бажанням нотатку для покупця, персональну нотатку та термін дії в годинах. У відповіді — адреса сторінки оплати виду
https://ibanoplata.com/iban-qr/<ідентифікатор>, яку можна одразу надіслати клієнту. - Отримати список посилань за період, сторінками.
- Видалити посилання — платник більше не зможе ним оплатити.
- Отримати реквізити кабінету і призупинити або відновити реквізити.
Посилання, створені через API, зʼявляються у списку Мої посилання поруч зі створеними вручну. Якщо в запиті прийшов IBAN, якого ще немає серед ваших реквізитів, API додає новий набір реквізитів на сторінку Мої реквізити сам.
Через API не створюються посилання з відкритою сумою і з запитом імені чи номера замовлення платника — такі посилання створюються лише в кабінеті. Щоб отримати QR-код для посилання з API, додайте до його адреси «/qr» — це описано в статті QR-код через пряме посилання.
Підключитися до API
- У кабінеті відкрийте сторінку API Токен і натисніть Згенерувати Токен. Як створити, скопіювати й безпечно зберігати токен — у статті API-токен.
- Внизу сторінки API Токен, у рядку «Swagger-документація знаходиться тут», натисніть тут. Відкриється документація Swagger з усіма запитами, їхніми полями й прикладами відповідей.
- У кожному запиті до API передавайте токен у заголовку
X-Api-Key. У документації Swagger токен можна ввести один раз і виконувати тестові запити просто зі сторінки. - Для першої перевірки виконайте запит списку реквізитів: відповідь без помилки означає, що токен і тариф підходять.
Робіть запити до API зі свого сервера, а не з коду сторінки в браузері відвідувача — інакше токен побачить кожен. Якщо власного сервера немає, скористайтеся динамічними посиланнями: їх налаштовує служба підтримки, і токен на сайті для них не потрібен.
Коли доступ зʼявляється після зміни тарифу
API перевіряє тариф кабінету на кожен запит і памʼятає результат пʼять хвилин. Тому після переходу на тариф з API або після оплати передплати доступ зʼявляється не миттєво, а протягом пʼяти хвилин; до того API ще відповідає помилкою доступу.
Те саме діє і в зворотний бік: коли платний або ознайомчий період закінчився, API працює ще приблизно добу після дати закінчення, а далі відповідає помилкою доступу, доки передплату не поновлено.
Термін дії посилань, створених через API
- Якщо запит до API містить термін дії в годинах, посилання діятиме саме стільки.
- Якщо терміну в запиті немає, посилання отримує термін дії за замовчуванням зі сторінки Налаштування — той самий, що й посилання, створені в кабінеті.
- Якщо термін за замовчуванням не встановлено, посилання з API діє без обмеження часу, доки ви його не видалите.
Як встановити термін за замовчуванням — у статті Термін дії посилань за замовчуванням.
Замовити допомогу з інтеграцією
Якщо інтеграцію з вашою CRM чи сайтом треба обговорити з менеджером, залиште номер телефону на сайті ibanoplata.com.
- На сайті ibanoplata.com у шапці натисніть Інтеграції. Сторінка прокрутиться до блоку «API-Інтеграція».
- У полі з прапорцем України введіть номер телефону повністю. Якщо номер неповний, зʼявиться підказка «Будь ласка, введіть номер телефону».
- Натисніть Замовити інтеграцію. Зʼявиться вікно «Дякуємо!» з текстом «Наш менеджер зателефонує Вам на номер:» і вашим номером.
Якщо щось не так
- API відповідає «Передплата закінчилася або ваш тариф не підтримує API-інтеграцію.» Ваш тариф не дає доступу до API або передплата закінчилася; тарифи, на яких це доступно, вказані над статтею. Оберіть потрібний тариф на сторінці Мій тариф і зачекайте до пʼяти хвилин.
- API не приймає токен. Токен скопійовано не повністю, токен видалено, або його перегенерували понад 12 годин тому, а інтеграція досі надсилає старий. Скопіюйте чинний токен зі сторінки API Токен.
- API відмовляє створити посилання на певний IBAN. Реквізити з цим IBAN призупинені: відновіть їх на сторінці Мої реквізити або через API. Якщо реквізити заблоковані сервісом, створення посилань на них недоступне ні в кабінеті, ні через API.
- Посилання з API закінчується раніше, ніж очікували. Запит не містив терміну дії, і спрацював термін за замовчуванням зі сторінки Налаштування. Передавайте термін у запиті або змініть значення за замовчуванням.