Przejdź do głównej treści
LLMs.md

API i eksport

Istnieją dwa sposoby przesyłania danych z LiteLog do innych systemów:

  1. REST API v1 — dla systemów innych firm, które automatycznie komunikują się z LiteLogiem: np. B. system zarządzania nieruchomością (PMS), który tworzy zadanie sprzątania podczas wymeldowania gościa, lub oprogramowanie pośredniczące synchronizujące główne dane nieruchomości.
  2. Eksport CSV i PDF — do płac, raportowania i wysyłania do klientów, bez linii kodu. Zobacz Eksport i wysyłka.

API RESTowe v1

Utwórz klucz API

Kluczami API zarządzasz w portalu w zakładce Ustawienia → Integracje na karcie REST API:

  1. Kliknij Utwórz klucz i nadaj nazwę (np. „Apartamenty wakacyjne PMS”).
  2. Wybierz Uprawnienia (zakresy), które ma mieć klucz — tylko tyle, ile jest konieczne.
  3. Surowy klucz (ll_live_…) zostanie wyświetlony dokładnie raz. Skopiuj go i przechowuj bezpiecznie — wtedy widoczny będzie tylko początek klucza.

Integracje

Klucz jest powiązany z Twoim klientem i dostępem - widzi dokładnie te obiekty, które widzi ten dostęp. Odwołanie staje się skuteczne natychmiast; aby rotacja przebiegała bezawaryjnie, najpierw utwórz nowy klucz, przekonwertuj system innej firmy, a następnie unieważnij stary.

Uwierzytelnianie

Każde żądanie zawiera klucz w nagłówku — jako X-Api-Key lub jako token okaziciela:

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 nadaje się jako pierwszy test: punkt końcowy zwraca kontekst klucza (klient, zakresy) bez konieczności posiadania dalszych uprawnień.

Punkty końcowe

Metoda i ścieżkaZamiarWymagany zakres
KOD0Klucz testowy: własny kontekst (klient, zakresy)
KOD0Lista obiektówKOD0
KOD0Utwórz obiektKOD0
KOD0Aktualizuj obiektKOD0
KOD0Lista zadańKOD0
KOD0Utwórz zadanie (idempotentne poprzez podany uuid)KOD0
KOD0Utwórz raport (incydent/wada).KOD0
KOD0Odpowiedzi na zapytania przesłane z formularza (odpytywanie)KOD0
KOD0Formularz odpowiedzi zawiera szczegółowe informacje, w tym odpowiedzi i linki do zdjęćKOD0

:::tip Idempotenz Podczas tworzenia zadań wpisz własny uuid - wielokrotne dostarczanie tego samego zdarzenia (np. ponowne dostarczenie Twojego PMS-a za pomocą webhooka) nigdy nie spowoduje utworzenia dwóch zadań. :::

Przykład: „Wyjazdy gości → zadanie sprzątania”

# 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"

Granice i zachowania

  • Limit szybkości: 120 żądań na minutę na klucz (HTTP 429 w przypadku przekroczenia).
  • Brak miejsca licencyjnego: Dostępy do API nie wymagają miejsca licencyjnego. Wygasła licencja blokuje dostęp do zapisu (odczyt pozostaje możliwy, podczas zapisu HTTP 402).
  • Format błędu: 401 (brak klucza/nieprawidłowy/unieważniony), 403 (brak dostępu do zakresu lub obiektu), 404 (brak zasobu), 409 (konflikt/duplikat), 400/422 (błąd walidacji - nieznane pola są odrzucane).
  • Jeszcze nie uwzględnione: Wychodzące webhooki (planowane — do tego czasu odpytywanie za pomocą GET /api/v1/form-responses?status=submitted), OAuth2, śledzenie czasu pisania lub odpowiedzi z formularzy, przesyłanie plików i DELETE punkty końcowe.

Eksport CSV i PDF

Nie potrzebujesz API do obsługi płac i raportowania – wbudowane eksporty obejmują najczęstsze przypadki:

  • Czasy pracy w formacie CSV — np.: B. macierz dziennej frekwencji na osobę dla listy płac.
  • Raporty w formacie PDF — raporty z wycieczek, powiadomień i formularzy, na żądanie w Twoim własnym Marka.
  • Cyklowe dostarczanie wiadomości e-mail — Automatyczne raporty, m.in. B. wysyłaj co tydzień do klientów.

Wszystkie szczegóły: Eksport i wysyłka i Przedmiot — Wysyłka.

Uprawnienia

:::info Berechtigung Aby tworzyć i unieważniać klucze API, potrzebujesz uprawnienia Edytuj ustawienia. To, co klucz może zobaczyć i zmienić, jest również ograniczone jego zakresem i dostępem, z którym jest powiązany. :::

Powiązane strony