Enterprise REST API pro správu nemovitostí - integrace s vašimi systémy

Як це працює

Proč potřebujete API pro správu nemovitostí?

Moderní správa nemovitostí vyžaduje propojení více systémů. Účetní software, bankovní systémy, CRM, helpdesk, IoT senzory - každý generuje nebo spotřebovává data o nemovitostech a nájemnících. Bez API musíte data přenášet ručně, což je pomalé, chybové a neškálovatelné.

Enterprise REST API v Grento poskytuje programový přístup ke všem datům a funkcím systému. Můžete vytvořit vlastní integraci s libovolným externím systémem, automatizovat opakující se procesy nebo vybudovat vlastní nadstavbu nad platformou Grento.

API je navrženo podle best practices: RESTful architektura, JSON formát, konzistentní chybové kódy, stránkování, filtrování a řazení. Vývojáři mohou začít s integrací během minut díky kompletní dokumentaci s příklady pro populární programovací jazyky.

Architektura a endpointy API

API v1 je dostupné na base URL /api/v1/ a poskytuje RESTful endpointy pro všechny hlavní entity v systému. Každá entita podporuje standardní CRUD operace: GET (čtení), POST (vytvoření), PATCH (aktualizace) a DELETE (smazání).

Dostupné endpointy zahrnují: /properties (nemovitosti a jednotky), /tenants (nájemníci), /contracts (nájemní smlouvy), /payments (platby a předpisy), /expenses (náklady a faktury), /documents (dokumenty a přílohy), /maintenance (požadavky na údržbu) a /analytics (finanční přehledy).

Filtrování je dostupné přes query parametry: ?status=active, ?property_id=123, ?date_from=2024-01-01. Stránkování používá offset/limit pattern s metadaty o celkovém počtu záznamů. Řazení přes ?sort=created_at&order=desc.

Response formát je standardizovaný JSON s konzistentní strukturou. Úspěšná odpověď obsahuje objekt 'data' s výsledky a objekt 'meta' s informacemi o stránkování. Chybová odpověď obsahuje objekt 'error' s kódem, zprávou a detaily.

Autentizace a bezpečnost

API používá autentizaci přes API klíče předávané v HTTP hlavičce X-API-Key. Každý klíč je kryptograficky generovaný řetězec, který identifikuje volajícího a jeho oprávnění. Klíče lze vytvářet, deaktivovat a mazat v administraci.

Granulární oprávnění umožňují pro každý klíč nastavit přesně, ke kterým endpointům a operacím má přístup. Například klíč pro účetní software může mít přístup pouze ke čtení plateb a nákladů, ale ne k úpravě nemovitostí nebo nájemníků.

Rate limiting chrání systém proti zneužití a zajišťuje stabilní výkon pro všechny uživatele. Standardní limit je 100 požadavků za minutu. Na Enterprise tarifu lze limit zvýšit podle potřeby. Při překročení limitu API vrátí status 429 s informací o tom, kdy lze pokračovat.

Každý API požadavek se zaznamenává do audit logu: timestamp, IP adresa, API klíč, endpoint, metoda, status code a doba odpovědi. Audit log je přístupný v administraci a umožňuje sledovat využití API i případné pokusy o zneužití.

Typické integrace a use cases

Integrace s ERP/účetním softwarem: automatický přenos faktur, plateb a nákladů. Nové doklady vytvořené v Grento se přes API přenesou do účetního systému, stavy zaplacení se synchronizují zpět. To je alternativa k přímému napojení POHODA/Money S3 pro uživatele jiných účetních systémů.

Integrace s BI nástroji: export dat o výnosnosti, obsazenosti a nákladech do Power BI, Tableau nebo Google Data Studio. API poskytuje analytické endpointy optimalizované pro reporting, včetně agregovaných dat za období.

Custom portál pro nájemníky: vybudujte vlastní webový portál nebo mobilní aplikaci pro nájemníky s využitím API. Nájemníci mohou vidět platby, hlásit závady a komunikovat se správcem přes vaše vlastní rozhraní.

IoT integrace: připojte senzory pro měření spotřeby energií, teploty nebo vlhkosti. Data ze senzorů můžete přes API ukládat k jednotlivým jednotkám a vizualizovat v dashboardu Grento.

Dokumentace a vývojářské nástroje

Kompletní dokumentace API je dostupná v interaktivním formátu. Pro každý endpoint najdete: popis funkcionality, parametry požadavku, formát odpovědi, příklady v cURL, Python, JavaScript a PHP, a chybové kódy.

Pro rychlý start je k dispozici kolekcí pro Postman a Insomnia s předkonfigurovanými požadavky. Stačí zadat API klíč a můžete testovat endpointy přímo z vašeho oblíbeného HTTP klienta.

API je standardní REST rozhraní s odpověďmi ve formátu JSON, takže ho napojíte z libovolného jazyka (Python, JavaScript/Node.js, PHP a další) pomocí běžných HTTP knihoven.

Sandbox prostředí umožňuje testovat API bez vlivu na produkční data. V sandboxu můžete vytvářet, upravovat a mazat testovací záznamy. Sandbox je automaticky resetován každých 24 hodin.

Rate limiting a škálovatelnost

Rate limiting je implementován pomocí sliding window algoritmu. Standardní limity jsou: 100 požadavků za minutu pro čtení (GET) a 30 požadavků za minutu pro zápis (POST/PATCH/DELETE). Enterprise tarif nabízí zvýšené limity až na 1000 req/min.

Při blížícím se limitu API vrací hlavičky X-RateLimit-Remaining a X-RateLimit-Reset, takže klient může adaptovat frekvenci požadavků. Při překročení limitu odpovídá status 429 Too Many Requests s informací o čase resetu.

Pro hromadné operace API nabízí batch endpointy, které umožňují vytvořit nebo aktualizovat více záznamů v jednom požadavku. Batch endpoint přijímá pole objektů a vrací výsledek pro každý objekt. To výrazně snižuje počet API volání.

Webhooky (plánovaná funkce) umožní přijímat notifikace o událostech v reálném čase. Místo pravidelného dotazování (polling) API odešle HTTP požadavek na váš server při změně dat - nová platba, expirace smlouvy, nový nájemník.

Для кого це ідеально

Часті запитання

Повʼязані функції