API

Що таке API?

API (інтерфейс прикладного програмування) дозволяє іншим сайтам або застосункам автоматично отримувати дані громади — наприклад, список об’єктів або користувачів.

Навіщо це потрібно?
  • Показати актуальний перелік об’єктів на сайті громади/області.
  • Підключити отримані дані до Excel, Google Таблиць, CRM тощо.
  • Створити звіт або дашборд без ручного копіювання.
Як використовувати?

Достатньо перейти за відповідним посиланням, наприклад:

https://<адреса-громади>.maino.pro/api/objects/

Формат: JSON — стандартний формат, який легко читають сайти, скрипти та сервіси.

Що таке <iframe>?

Iframe — це HTML-тег, який дозволяє вставити частину іншого сайту всередину свого сайту.

Навіщо це потрібно?
  • Показати перелік об’єктів чи користувачів громади на іншому сайті — без дублювання даних.
  • Завжди мати актуальні дані (інформація оновлюється автоматично на всіх сайтах).
  • Легко інтегрувати — не потрібно знати програмування.
Як виглядає приклад вставки?

Достатньо додати код на сторінку, наприклад:

<iframe src="https://<адреса-громади>.maino.pro/object_iframe/" width="100%" height="600" frameborder="0"></iframe>

Так можна вивести список об'єктів або користувачів громади прямо на сайті Ради або ЦНАПу.

/api/objects/
Перелік об’єктів:

Білгород-Дністровська міська територіальна громада Білгород-Дністровський район Одеська область

GET https://bilhorod.maino.pro/api/objects/

Основні поля:
  • address — Адреса
  • title — Назва
  • components — Складові частини
  • share_size — Частка
  • total_area — Загальна площа (м²)
  • purpose — Цільове призначення
<iframe src="https://bilhorod.maino.pro/object_iframe/" width="100%" height="600" style="border:1px solid #ccc;"></iframe>
/api/subjects/
Перелік користувачів:

Білгород-Дністровська міська територіальна громада Білгород-Дністровський район Одеська область

GET https://bilhorod.maino.pro/api/subjects/

Основні поля:
  • person_title — Користувач
  • object_address — Адреса об’єкта
  • title — Назва
  • components — Складові частини
  • size — Частка
  • area — Площа (м²)
  • type_display — Тип користування
  • date_start — Дата початку
  • date_end — Дата завершення
<iframe src="https://bilhorod.maino.pro/subject_iframe/" width="100%" height="600" style="border:1px solid #ccc;"></iframe>