API 2.2 - Загальна інформація

Загальна інформація 

API (Application Programming Interface) — це набір готових класів, процедур, функцій, структур і констант, що надаються додатком (бібліотекою, сервісом) для використання в зовнішніх програмних продуктах. API виступає посередником між розробником додатків і будь-яким середовищем, з яким цей додаток повинен взаємодіяти.

У Finmap відкритий API, який можуть використовувати юзери для власних потреб і налаштування індивідуальних інтеграцій з сервісом. Переглянути інформацію по API можна у розділі Налаштування – Налаштування компанії, блок – Розробникам. Тут ви знайдете інформацію про АРІ-документацію.

📎 Або ж можете віднайти її за цим посиланням: https://api.finmap.online/

💡 Якщо ваша мета — підключити Finmap до AI-помічника (Claude, ChatGPT тощо), а не будувати власну інтеграцію, скористайтесь MCP: Підключення Finmap до AI-помічника (MCP).

Ключ API – це ключ шифрування для автентифікації користувача в системі, за аналогією логіну та паролю.
API-документація Finmap створена на базі ресурсу Swagger

Блоки в АРІ-документації 

Документація розділена на блоки:

• webhooks - блок який допомогає працювати із вебхуками
• default - загальна перевірка на працездатність
• currencies - показує в якій валюті можна відкрити компанію
• accounts - робота із рахунками
• tags - робота із тегами
• projects - робота із проектами
• categories/income - робота із категоріями доходу
• categories/expense  - робота із категоріями витрати
• customers - робота із клієнтами
• investors- робота із інвесторами
• creditors - робота із кредиторами
• debitors - робота із позичальниками
• suppliers - робота із постачальниками
• employees - робота із співробітниками
• owners - робота із власниками
• operations/income - робота із операціями доходу
• operations/expense - робота із операціями витрат
• operations/transfer - робота із переказами

Для певних блоків доступна можливість перегляду, редагування, видалення, додавання. До таких блоків відносяться:

• tags 
• projects 
• categories/income 
• categories/expense 
• customers 
• investors
• creditors 
• debitors 
• suppliers 
• employees 
• owners 

Через наступні блоки є можливість тільки додавати операції.  До них належать:

• operations/income
• operations/expense
• operations/transfer

❌ Виключенням є блок accounts,  через цей блок можна лише отримувати інформацію про те, які рахунки є в сервісі

Методи запитів 

• GET — Використовується для отримання або читання даних. Запити з використанням цього методу можуть тільки отримувати дані.
• PATCH — зазвичай використовується для оновлення ресурсу, шляхом заміни даних запиту.
• POST — зазвичай використовується для створення нового ресурсу причому, ніхто не побачить цю інформацію після того, як ви її відправили.
• DELETE — видаляє дані.

Ліміти запитів 

На всі методи API діють спільні ліміти на компанію:

• 10 запитів за 5 секунд
• 120 запитів за хвилину
• 10 000 запитів на добу

Раніше обмеження стосувалось тільки журналу операцій — тепер ліміти єдині для всіх методів API.

Як зрозуміти, що ви наближаєтесь до ліміту. У відповіді на кожен запит повертаються два заголовки:

• Remaining-Req-Count — скільки запитів ще залишилось у поточному вікні;
• Next-Possibility-At — час, коли можна буде надіслати наступний запит, якщо ліміт вичерпано.

Що зробити, щоб не впиратися в ліміт:

• Замість постійного опитування API налаштуйте вебхуки — Finmap сам повідомить про зміни, і додаткові запити не знадобляться.
• Вивантажуйте дані пачками за період (наприклад, усі операції за день одним запитом), а не робіть окремий запит на кожну операцію.

Якщо ваша інтеграція справді потребує більшої пропускної здатності, з 27.08.2026 доступний додатковий пакет +100 запитів/хв: $10/міс, $60 за 6 місяців або $120 за рік.

Якщо залишились питання

Якщо у вас виникнуть питання щодо документації API або є приклад технічного запиту, який ви хочете вирішити, будь ласка, напишіть нам на пошту support-team@finmap.online.

В листі потрібно описати наступне: “Запит …, не працює (з’являється така відповідь) коли ви надсилаєте параметри …”. Наш технічний фахівець розгляне ваш запит (опрацювання запитів відбувається в межах 24 годин) і надасть кваліфіковану відповідь.