ㅤВремя прочтения — 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 — удаляет данные.