Підключіть Grento до будь-якої зовнішньої системи
Enterprise REST API для управління нерухомістю - інтеграція з вашими системами
Повний REST API v1 для програмного доступу до даних про нерухомість, орендарів, договори та платежі. Автентифікація API-ключем, гранульовані права та обмеження частоти запитів (rate limiting).
Інтеграція з будь-чим
Зв'яжіть управління нерухомістю з ERP, CRM, бухгалтерією, BI-інструментами або власним додатком через стандартний REST API.
Автоматизація робочих процесів
Автоматизуйте повторювані процеси: синхронізація даних, генерація звітів, імпорт платежів із зовнішніх джерел.
Безпека корпоративного рівня
Автентифікація API-ключем, гранульовані права, обмеження частоти запитів та повний аудит-лог. Безпечно навіть для критично важливих додатків.
Як це працює
Автентифікація API-ключем
Створюйте та керуйте API-ключами з власними правами доступу. Кожен ключ може мати доступ лише до конкретних ендпоінтів.
Гранульовані права
Налаштуйте точно, що дозволено кожному API-ключу: читання нерухомості, запис платежів, управління орендарями. 15+ груп прав.
Обмеження частоти запитів (rate limiting)
Захист від зловживань з налаштовуваним лімітом запитів. За замовчуванням 100 запитів на хвилину з можливістю збільшення на тарифі Enterprise.
JSON-відповіді
Стандартний формат JSON для всіх відповідей з консистентною структурою, пагінацією та фільтрацією.
CRUD-операції
Повні операції Create, Read, Update, Delete для всіх сутностей: нерухомість, одиниці, орендарі, договори, платежі, витрати.
Аудит-лог
Кожен запит до API записується: хто, коли, що, звідки. Повний огляд використання API.
Навіщо вам потрібен API для управління нерухомістю?
Сучасне управління нерухомістю вимагає зв'язку між кількома системами. Бухгалтерське ПЗ, банківські системи, CRM, техпідтримка, IoT-датчики , кожне з них генерує або споживає дані про нерухомість та орендарів. Без API вам доведеться переносити дані вручну, що повільно, схильно до помилок і не масштабується.
Enterprise REST API в Grento забезпечує програмний доступ до всіх даних і функцій системи. Ви можете створити власну інтеграцію з будь-якою зовнішньою системою, автоматизувати повторювані процеси або побудувати власну надбудову над платформою Grento.
API розроблено відповідно до найкращих практик: архітектура RESTful, формат JSON, консистентні коди помилок, пагінація, фільтрація та сортування. Розробники можуть почати інтеграцію за лічені хвилини завдяки повній документації з прикладами для популярних мов програмування.
Архітектура та ендпоінти API
API v1 доступний за базовою адресою /api/v1/ і надає RESTful-ендпоінти для всіх основних сутностей у системі. Кожна сутність підтримує стандартні CRUD-операції: GET (читання), POST (створення), PATCH (оновлення) та DELETE (видалення).
Доступні ендпоінти включають: /properties (нерухомість та одиниці), /tenants (орендарі), /contracts (договори оренди), /payments (платежі та нарахування), /expenses (витрати та рахунки), /documents (документи та вкладення), /maintenance (заявки на обслуговування) та /analytics (фінансові звіти).
Фільтрація доступна через параметри запиту: ?status=active, ?property_id=123, ?date_from=2024-01-01. Пагінація використовує шаблон offset/limit з метаданими про загальну кількість записів. Сортування через ?sort=created_at&order=desc.
Формат відповіді , стандартизований JSON з консистентною структурою. Успішна відповідь містить об'єкт 'data' з результатами та об'єкт 'meta' з інформацією про пагінацію. Відповідь про помилку містить об'єкт 'error' з кодом, повідомленням та деталями.
Автентифікація та безпека
API використовує автентифікацію через API-ключі, що передаються в HTTP-заголовку X-API-Key. Кожен ключ , це криптографічно згенерований рядок, який ідентифікує того, хто викликає, та його права доступу. Ключі можна створювати, деактивувати та видаляти в адмін-панелі.
Гранульовані права дозволяють для кожного ключа точно налаштувати, до яких ендпоінтів та операцій він має доступ. Наприклад, ключ для бухгалтерського ПЗ може мати доступ лише до читання платежів і витрат, але не до редагування нерухомості чи орендарів.
Rate limiting захищає систему від зловживань і забезпечує стабільну продуктивність для всіх користувачів. Стандартний ліміт , 100 запитів на хвилину. На тарифі Enterprise ліміт можна збільшити за потребою. При перевищенні ліміту API повертає статус 429 з інформацією про те, коли можна продовжити.
Кожен запит до API записується в аудит-лог: мітка часу, IP-адреса, API-ключ, ендпоінт, метод, код статусу та час відповіді. Аудит-лог доступний в адмін-панелі та дозволяє відстежувати використання API і можливі спроби зловживань.
Типові інтеграції та кейси
Інтеграція з ERP/бухгалтерським ПЗ: автоматична передача рахунків, платежів і витрат. Нові документи, створені в Grento, передаються через API в бухгалтерську систему, статуси оплати синхронізуються назад. Це альтернатива прямому підключенню POHODA/Money S3 для користувачів інших бухгалтерських систем.
Інтеграція з BI-інструментами: експорт даних про прибутковість, заповнюваність і витрати в Power BI, Tableau або Google Data Studio. API надає аналітичні ендпоінти, оптимізовані для звітності, включаючи агреговані дані за період.
Кастомний портал для орендарів: створіть свій вебпортал або мобільний додаток для орендарів з використанням API. Орендарі можуть бачити платежі, повідомляти про несправності та спілкуватися з керуючим через ваш власний інтерфейс.
IoT-інтеграція: підключіть датчики для вимірювання енергоспоживання, температури або вологості. Дані з датчиків можна зберігати через API для окремих одиниць і візуалізувати в панелі управління Grento.
Документація та інструменти для розробників
Повна документація API доступна в інтерактивному форматі. Для кожного ендпоінта ви знайдете: опис функціоналу, параметри запиту, формат відповіді, приклади на cURL, Python, JavaScript і PHP, а також коди помилок.
Для швидкого старту доступна колекція для Postman і Insomnia з передналаштованими запитами. Достатньо ввести API-ключ, і можна тестувати ендпоінти прямо з вашого улюбленого HTTP-клієнта.
API , це стандартний інтерфейс REST з відповідями у форматі JSON, тому ви можете підключити його з будь-якої мови (Python, JavaScript/Node.js, PHP та інші) за допомогою звичайних HTTP-бібліотек.
Пісочниця (sandbox) дозволяє тестувати API без впливу на продуктові дані. У пісочниці можна створювати, редагувати та видаляти тестові записи. Пісочниця автоматично скидається кожні 24 години.
Rate limiting та масштабованість
Rate limiting реалізовано за допомогою алгоритму sliding window. Стандартні ліміти: 100 запитів на хвилину для читання (GET) і 30 запитів на хвилину для запису (POST/PATCH/DELETE). Тариф Enterprise пропонує збільшені ліміти до 1000 запитів на хвилину.
При наближенні до ліміту API повертає заголовки X-RateLimit-Remaining і X-RateLimit-Reset, щоб клієнт міг адаптувати частоту запитів. При перевищенні ліміту відповідає статусом 429 Too Many Requests з інформацією про час скидання.
Для масових операцій API пропонує пакетні (batch) ендпоінти, що дозволяють створити або оновити кілька записів в одному запиті. Пакетний ендпоінт приймає масив об'єктів і повертає результат для кожного об'єкта. Це значно знижує кількість викликів API.
Вебхуки (планована функція) дозволять отримувати сповіщення про події в реальному часі. Замість регулярного опитування (polling), API надішле HTTP-запит на ваш сервер при зміні даних , новий платіж, закінчення терміну договору, новий орендар.
Для кого це ідеально
Інтеграція з SAP
Велика керуюча компанія зв'язала Grento з SAP Business One через API. Рахунки і платежі синхронізуються автоматично без ручного втручання.
Кастомний дашборд
Розробник побудував власний дашборд Power BI з даними з API. Керівництво бачить KPI портфеля в реальному часі на великому екрані.
Мобільний додаток
Керуюча компанія розробила власний мобільний додаток для техніків на виїздах. Через API він завантажує деталі нерухомості та зберігає протоколи оглядів.
Автоматизація через Zapier
Орендодавець підключив API через Zapier до Gmail та Slack. При надходженні нового платежу він отримує сповіщення, при простроченні платежу автоматично надсилається нагадування.
Сховище даних (Data warehouse)
Інвестор завантажує історичні дані з API у власне сховище даних для просунутої аналітики та моделей machine learning.
Мультисистемна синхронізація
Агентство нерухомості синхронізує дані між Grento, власною CRM і вебсайтами з пропозиціями нерухомості.
API nám umožnilo propojit Grento s naším interním systémem za dva dny. Dokumentace je skvělá a SDK pro Node.js nám ušetřilo spoustu práce.
Часті запитання
Які тарифи включають доступ до API?
API доступний починаючи з тарифу Business. Тариф Enterprise пропонує збільшені ліміти, пріоритетну підтримку та середовище пісочниці.
Чи доступна документація API публічно?
Так, документація API публічно доступна без необхідності входу в систему. Ви можете вивчити ендпоінти та моделі даних перед прийняттям рішення про використання.
Чи можу я використовувати API для комерційної інтеграції?
Так, ви можете використовувати API для інтеграції зі своїми системами, а також для розробки комерційних продуктів. Для участі в партнерській програмі з розширеним доступом зв'яжіться з нами.
Чи підтримуєте ви GraphQL?
Наразі ми пропонуємо REST API. GraphQL планується у майбутніх версіях. Завдяки фільтрації та параметрам select у REST API ви вже зараз можете ефективно завантажувати лише необхідні дані.
Як ви вирішуєте питання зворотної сумісності?
API v1 стабільний, і ми не випускаємо ламаючих змін без попереднього повідомлення. Нові функції додаються з дотриманням зворотної сумісності. При великих змінах ми підготуємо v2 з достатнім перехідним періодом.