API a exporty
Existují dva způsoby, jak získat data z LiteLog do jiných systémů:
- REST API v1 — pro systémy třetích stran, které automaticky komunikují s LiteLog: např. B. Systém správy nemovitostí (PMS), který vytváří úlohu úklidu během hostování, nebo middleware, který synchronizuje kmenová data nemovitosti.
- Exporty CSV a PDF — pro mzdy, výkaznictví a zasílání klientům, bez řádku kódu. Viz Export & Shipping.
REST API v1
Vytvořit klíč API
Klíče API spravujete na portálu v části Nastavení → Integrace na kartě REST API:
- Klikněte na Vytvořit klíč a přiřaďte název (např. „PMS prázdninové byty“).
- Vyberte Oprávnění (rozsahy), která chcete, aby klíč měl – jen tolik, kolik je nutné.
- Nezpracovaný klíč (
ll_live_…) se zobrazí přesně jednou. Zkopírujte jej a bezpečně uložte — poté bude viditelný pouze začátek klíče.
Klíč je svázán s vaším klientem a přístupem – vidí přesně ty objekty, které tento přístup vidí. Odvolání nabývá účinnosti okamžitě; pro rotaci bez selhání nejprve vytvořte nový klíč, převeďte systém třetí strany a poté zrušte starý.
Autentizace
Každý požadavek nese klíč v záhlaví — buď jako X-Api-Key, nebo jako nosič:
curl -H "X-Api-Key: ll_live_..." https://api.litelog.de/api/v1/me
# oder
curl -H "Authorization: Bearer ll_live_..." https://api.litelog.de/api/v1/me
GET /v1/me je vhodný jako první test: koncový bod vrací kontext klíče (klient, rozsahy) bez nutnosti dalších oprávnění.
Koncové body
| Metoda a cesta | Účel | Požadovaný rozsah |
|---|---|---|
GET /api/v1/me | Testovací klíč: vlastní kontext (klient, rozsahy) | — |
GET /api/v1/properties | Seznam objektů | properties:read |
POST /api/v1/properties | Vytvořit objekt | properties:write |
PATCH /api/v1/properties/:id | Aktualizovat objekt | properties:write |
GET /api/v1/tasks | Seznam úkolů | tasks:read |
POST /api/v1/tasks | Vytvořit úkol (idempotentní prostřednictvím poskytnutého uuid) | tasks:write |
POST /api/v1/incidents | Vytvořte zprávu (incident/defekt). | incidents:write |
GET /api/v1/form-responses | Odpovědi z formuláře odeslané na dotazy (dotazování) | form_responses:read |
GET /api/v1/form-responses/:id | Formulujte odpověď podrobně, včetně odpovědí a odkazů na fotografie | form_responses:read |
:::tip Idempotenz
Při vytváření úkolů zadejte svůj vlastní uuid - opakované doručení stejné události (např. opětovné doručení vašeho PMS webhookem) pak nikdy nevytvoří dva úkoly.
:::
Příklad: „Odchází hostů → úklid“
# Checkout-Event → Reinigungsaufgabe
curl -X POST https://api.litelog.de/api/v1/tasks \
-H "X-Api-Key: $KEY" -H "Content-Type: application/json" \
-d '{"uuid":"7c9e6679-7425-40de-944b-e07fc1f90ae7","title":"Endreinigung Wohnung 3","property_id":123,"due_date":"2026-08-01"}'
# Fertige Reinigungs-Checkliste abfragen (Polling)
curl "https://api.litelog.de/api/v1/form-responses?property_id=123&status=submitted&pageSize=10" \
-H "X-Api-Key: $KEY"
Hranice a chování
- Limit rychlosti: 120 požadavků za minutu na klíč (HTTP 429, pokud je překročen).
- Žádné licenční místo: Přístupy k API nezabírají licenční místo. Prošlá licence blokuje přístup pro zápis (čtení zůstává možné, HTTP 402 při zápisu).
- Formát chyby: 401 (chybějící/neplatný/odvolaný klíč), 403 (chybí rozsah nebo přístup k objektu), 404 (zdroj není k dispozici), 409 (konflikt/duplikát), 400/422 (chyba ověření – neznámá pole jsou odmítnuta).
- Zatím není zahrnuto: Odchozí webhooky (plánované – do té doby dotazování přes
GET /api/v1/form-responses?status=submitted), OAuth2, sledování času psaní nebo odpovědi na formuláře, nahrávání souborů a DELETE koncové body.
Exporty CSV a PDF
Nepotřebujete API pro mzdy a výkaznictví – vestavěné exporty pokrývají nejběžnější případy:
- Pracovní doba jako CSV — např. B. matice denní docházky na osobu pro mzdy.
- Zprávy ve formátu PDF – zprávy o prohlídkách, oznámeních a formulářích ve vašem vlastním Branding na vyžádání.
- Opakované doručování e-mailů — Hlásí se automaticky, např. B. posílat týdně klientům.
Všechny podrobnosti: Export & Shipping a Objekt — Doprava.
Oprávnění
:::info Berechtigung K vytváření a odvolávání klíčů API potřebujete oprávnění Upravit nastavení. To, co klíč může vidět a změnit, je také omezeno jeho rozsahem a přístupem, ke kterému je vázán. :::