Interfejs API REST i PMS | LiteLog
Otwarte API REST dla systemów PMS i innych firm: łącz obiekty, zadania, wiadomości i listy kontrolne za pomocą klucza API. Z pakietu Standard (6-15 użytkowników).
Otwórz API REST dla systemów innych firm
Dzięki REST API możesz uzyskać dostęp do LiteLog z poziomu swojego systemu zarządzania nieruchomością, ERP lub własnych narzędzi. Cztery zasoby obejmują codzienną integrację: obiekty (czytaj, twórz, zmieniaj), zadania (czytaj, twórz), wiadomości (twórz) i odpowiedzi z przesłanych formularzy, w tym zdjęcia (czytaj). Interfejs jest zgodny z typowymi konwencjami REST z JSON i specyfikacją OpenAPI.
- ✓Obiekty, zadania, wiadomości, odpowiedzi z formularzy
- ✓Standardowy REST ze specyfikacją JSON i OpenAPI
- ✓Dostęp API nie zajmuje miejsca użytkownika
Goście wychodzą → zadanie sprzątania
Klasyk wynajmu apartamentów wakacyjnych: podczas wymeldowania Twój PMS automatycznie tworzy zadanie sprzątania końcowego dla właściwej nieruchomości - dzięki ochronie idempotentnej nigdy nie ma duplikatu zadania, nawet jeśli zdarzenia są wysyłane dwukrotnie. Po przesłaniu listy kontrolnej czyszczenia PMS pobiera wyniki wraz ze zdjęciami. Dostawcy usług facility management łączą swoje systemy ERP lub CAFM w ten sam sposób, aby synchronizować dane podstawowe nieruchomości.
- ✓Zadania idempotentne — zduplikowane zdarzenia PMS nigdy nie powodują utworzenia dwóch zadań
- ✓Protokół przekazania ze zdjęciami na żądanie
- ✓Synchronizuj dane podstawowe obiektu z systemu zarządzania
Klucze API i uprawnienia (zakresy)
Klucze API tworzysz samodzielnie w portalu - bez zgłoszenia do pomocy technicznej. Każdy klucz jest powiązany z dzierżawcą i dostępem i widzi dokładnie te obiekty, które widzi ten dostęp. Uprawnienia (zakresy) również ograniczają to, co każdy klucz może zrobić. Surowy klucz jest wyświetlany dokładnie raz; Odwołanie staje się skuteczne natychmiast, rotacja przebiega bezawaryjnie.
- ✓Szczegółowe uprawnienia na klucz
- ✓Widoczność jak połączony dostęp
- ✓Natychmiastowe anulowanie, rotacja bez awarii
Bezpieczeństwo i jasne granice
API zaprojektowano z myślą o niezawodnym działaniu: 120 żądań na minutę na klucz, ścisła walidacja (nieznane pola są odrzucane) i czytelne kody błędów. I uczciwie wymieniamy to, czego (wciąż) brakuje: planowane są webhooki – do tego czasu możesz na żądanie przeglądać nowe listy kontrolne; OAuth2 i usuwanie poprzez API są celowo niedostępne. Hostowane w Niemczech, zgodne z RODO.
- ✓120 żądań/minutę na klucz
- ✓Ścisła weryfikacja, jasne kody błędów
- ✓Planowane webhooki - ankieta dzisiaj
FAQ
Często zadawane pytania dotyczące interfejsu API REST (FAQ)
Z jakiego pakietu dostępne jest API REST?
Interfejs API REST jest zawarty w pakiecie Standard (6-15 użytkowników) i jest również dostępny w wersjach Premium (16-30 użytkowników) i Enterprise. Nie jest on zawarty w pakiecie startowym.
Czy dostęp do API zajmuje przestrzeń użytkownika?
Nie. Dostęp API nie zajmuje miejsca licencyjnego. Jeśli licencja wygasła, dostęp do odczytu pozostaje otwarty, a dostęp do zapisu jest zablokowany.
Czy istnieją webhooki?
Jeszcze nie — webhooki są w planach. Do tego czasu Twój system innej firmy będzie sprawdzał nowe dane (odpytywanie), na przykład przesłane listy kontrolne.
Jakie dane mogę czytać i zapisywać poprzez API?
Czytaj, twórz i zmieniaj obiekty; czytać i tworzyć zadania; tworzyć raporty; Pobierz przesłane odpowiedzi z formularza, w tym linki do zdjęć. Celowo nie uwzględniono usuwania poprzez API, przesyłania plików i rejestrowania czasu zapisu.
Jak utworzyć i zabezpieczyć klucz API?
W portalu w zakładce Ustawienia → Integracje → REST API. Podczas tworzenia wybierasz nazwę i uprawnienia; klawisz zostanie wyświetlony dokładnie raz. Unieważnienie staje się skuteczne natychmiast, a aby dokonać zmiany, najpierw tworzysz nowy klucz, a następnie unieważniasz stary – bez żadnych przestojów.