ㅤЧас читання матеріалу – 6 хв
ㅤFinmap
ㅤ
Загальна інформація 🖇️
ㅤAPI (Application Programming Interface) — це набір готових класів, процедур, функцій, структур і констант, що надаються додатком (бібліотекою, сервісом) для використання в зовнішніх програмних продуктах. API виступає посередником між розробником додатків і будь-яким середовищем, з яким цей додаток повинен взаємодіяти.
ㅤУ Finmap відкритий API, який можуть використовувати юзери для власних потреб і налаштування індивідуальних інтеграцій з сервісом. Переглянути інформацію по API можна у розділі Налаштування – Налаштування компанії, блок – Розробникам. Тут ви знайдете інформацію про АРІ-документацію.
📎 Або ж можете віднайти її за цим посиланням: https://api.finmap.online/
ㅤ
ㅤКлюч 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 або є приклад технічного запиту, який ви хочете вирішити, будь ласка, напишіть нам на пошту support-team@finmap.online.
В листі потрібно описати наступне: “Запит …, не працює (з’являється така відповідь) коли ви надсилаєте параметри …”. Наш технічний фахівець розгляне ваш запит (опрацюбвання запитів відбувається в межах 24 годин) і надасть кваліфіковану відповідь.
ㅤ
ㅤ