API reference

REST API Flowtly — 927 кінцевих точок у 192 ресурсах, згенеровано з актуальної схеми OpenAPI.

Цей довідник згенеровано зі схеми API. Описи полів і будь-який текст, який ще не перекладено, показано англійською.

Перед початком розробки

Автентифікація

Надсилайте персональний токен доступу в заголовку Authorization: Bearer <token>. Створіть його у Flowtly на сторінці «Безпека» вашого профілю. Токен діє з вашими власними правами, дійсний 365 днів, якщо ви не оберете інакше (максимум 730), і його можна відкликати там у будь-який момент.

Заголовок організації

Кожен запит також містить заголовок instance з ідентифікатором організації, в якій ви працюєте. Без нього API відхиляє запит.

Запити та відповіді

Відповіді надходять у форматі JSON-LD (application/ld+json) або звичайного JSON (application/json). Оновлення використовують PATCH з application/merge-patch+json. Колекції розбиваються на сторінки за допомогою page і itemsPerPage, щонайбільше 500 елементів на сторінку.

Версіонування

API не версіонується ні в шляхах, ні в заголовках: ресурси розташовані в корені, наприклад https://api.flowtly.eu/projects. Документ OpenAPI 3.1 опубліковано за адресою https://api.flowtly.eu/docs.json.

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

Кількість запитів обмежена. Запити на запис (POST, PUT, PATCH, DELETE) рахуються для кожної організації за п'ятихвилинний проміжок, а ліміт вищий, щойно організацію верифіковано або вона має підписку. Після перевищення ліміту API відповідає 429 Too Many Requests із заголовком Retry-After, що вказує, скільки секунд чекати. Ліміти можуть змінюватися, тому читайте Retry-After, а не вписуйте число в код.

Застарілі елементи

Кінцева точка або поле, які виводяться з обігу, позначені в документі OpenAPI як deprecated. API не надсилає заголовків про застарівання, тож під час оновлення інтеграції перевіряйте цей документ.

Тестування інтеграції

Окремого тестового середовища немає. Перевіряйте інтеграцію в пробному робочому просторі на тестових даних, перш ніж підключати реальні. Доки організацію не верифіковано і вона не має підписки, пробний простір працює з нижчим лімітом запису й не надсилає електронних листів.

Що змінилося

Зміни в API анонсуються в примітках до релізів разом з рештою продукту.

Читати примітки до релізів

Проєкти та реалізація

97

Проєкти, завдання, учасники, ставки та розподіли — автоматизуйте виконання робіт і синхронізуйте дані проєктів.

Ресурсування та потужність

11

Алокації, резерв, вікно графіка та фактичні дані — плануйте, хто над чим працює, і перевіряйте, що вони фактично зробили.

Рахунки та платежі

49

Рахунки, позиції, платежі, нагадування та електронне фактурування (KSeF) — автоматизуйте виставлення рахунків від початку до кінця.

Бюджети та видатки

159

Бюджети, транзакції, витрати, податки та банківські рахунки — відстежуйте витрати та звіряйте дані автоматично.

CRM — ліди та угоди

78

Ліди, угоди, воронки та етапи — керуйте вирвою продажів зі своїх систем.

Клієнти та контрагенти

34

Клієнти, контакти та контрагенти — синхронізуйте вашу CRM та Flowtly.

HR та персонал

87

Співробітники, відділи, посади, пільги та відповідальності — автоматизуйте HR-процеси.

Ефективність і оцінювання

31

Цикли, шаблони, питання та сесії оцінювання — проводьте оцінку ефективності програмно.

Час та відвідування

67

Робочий час, відпустки, графіки та свята — логуйте та читайте відвідування програмно.

Рекрутмент та ATS

40

Кандидати, завдання підбору, співбесіди та планування — підключіть свою ATS.

Власність та активи

50

Об'єкти нерухомості, бронювання, активи, лічильники та показники — керуйте даними нерухомості через API.

Контракти та відповідність

48

Угоди, договори, вкладення та графіки платежів — автоматизуйте роботу з договорами.

Документи та підписи

20

Документи, сховище та запити на електронний підпис — завантажуйте, впорядковуйте та підписуйте файли.

Налаштування та теги

62

Атрибути, набори атрибутів, правила та теги — розширюйте об'єкти Flowtly власними полями.

Організація та конфігурація

48

Організація, локації, користувачі, інтеграції та підписка — налаштуйте робочий простір.

Користувачі та доступ

16

Користувачі та групи дозволів — керуйте тим, хто що бачить і може робити.

Webhook та аудит

14

Webhook та журнали аудиту — реагуйте на події та відстежуйте зміни.

Експорти для бухгалтерії

16

Експорти у Wapro, Optima, Enova, Symfonia, MT940 та SEPA — передавайте дані бухгалтеру.

MCP server

Підключіть AI інструменти до Flowtly через Model Context Protocol на mcp.flowtly.eu.