API та експорт
Є два способи отримати дані з LiteLog в інші системи:
- REST API v1 — для систем сторонніх розробників, які автоматично спілкуються з LiteLog: напр. B. система управління власністю (PMS), яка створює завдання очищення під час перевірки гостя, або проміжне програмне забезпечення, яке синхронізує основні дані власності.
- Експорт CSV і PDF — для нарахування заробітної плати, звітності та надсилання клієнтам без рядка коду. Перегляньте Експорт і доставка.
REST API v1
Створити ключ API
Ви керуєте ключами API на порталі в розділі Налаштування → Інтеграції на картці REST API:
- Натисніть Створити ключ і призначте ім’я (наприклад, «PMS holiday apartments»).
- Виберіть Дозволи (області), які ви хочете мати для ключа — лише стільки, скільки необхідно.
- Необроблений ключ (
ll_live_…) відображається рівно один раз. Скопіюйте його та зберігайте в надійному місці — після цього буде видно лише початок ключа.
Ключ прив'язаний до вашого клієнта і доступу - він бачить саме ті об'єкти, які бачить цей доступ. Відкликання набуває чинності негайно; для безпомилкової ротації спочатку створіть новий ключ, конвертуйте сторонню систему, а потім анулюйте стару.
Аутентифікація
Кожен запит містить ключ у заголовку — або як X-Api-Key, або як маркер носія:
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 підходить як перший тест: кінцева точка повертає контекст ключа (клієнт, області), не вимагаючи додаткових дозволів.
Кінцеві точки
| Спосіб і шлях | призначення | Необхідний обсяг |
|---|---|---|
GET /api/v1/me | Тестовий ключ: власний контекст (клієнт, області) | — |
GET /api/v1/properties | Список об’єктів | properties:read |
POST /api/v1/properties | Створити об'єкт | properties:write |
PATCH /api/v1/properties/:id | Об'єкт оновлення | properties:write |
GET /api/v1/tasks | Список завдань | tasks:read |
POST /api/v1/tasks | Створити завдання (ідемпотентне через наданий uuid) | tasks:write |
POST /api/v1/incidents | Створіть звіт (інцидент/дефект). | incidents:write |
GET /api/v1/form-responses | Відповіді форми надісланого запиту (опитування) | form_responses:read |
GET /api/v1/form-responses/:id | Детальна форма відповіді, включаючи відповіді та посилання на фото | form_responses:read |
:::tip Idempotenz
Створюючи завдання, введіть власний uuid – повторні доставки однієї події (наприклад, повторна доставка вебхуком вашого PMS) ніколи не створять двох завдань.
:::
Приклад: «Гість йде → завдання прибирання»
# 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"
Межі та поведінка
- Обмеження швидкості: 120 запитів на хвилину на ключ (HTTP 429, якщо перевищено).
- Немає ліцензійного місця: Доступ до API не займає ліцензійного місця. Прострочена ліцензія блокує доступ для запису (читання залишається можливим, HTTP 402 під час запису).
- Формат помилки: 401 (ключ відсутній/недійсний/відкликаний), 403 (область або доступ до об’єкта відсутній), 404 (ресурс відсутній), 409 (конфлікт/дублікат), 400/422 (помилка перевірки – невідомі поля відхилено).
- Ще не включено: Вихідні веб-хуки (заплановано — до того часу опитування через
GET /api/v1/form-responses?status=submitted), OAuth2, запис відстеження часу або відповідей у формі, завантаження файлів і кінцеві точки DELETE.
Експорт CSV і PDF
Вам не потрібен API для нарахування заробітної плати та звітності — вбудований експорт охоплює найпоширеніші випадки:
- Робочий час як CSV — напр. B. матриця щоденної відвідуваності на одну особу для нарахування заробітної плати.
- Звіти у форматі PDF — звіти про огляди, повідомлення та форми у вашому брендинг за запитом.
- Повторна доставка електронної пошти — звіти створюються автоматично, напр. Б. щотижня надсилати клієнтам.
Усі деталі: Експорт і доставка та Об'єкт — Доставка.
Дозволи
:::info Berechtigung Щоб створити та відкликати ключі API, вам потрібен дозвіл Редагувати налаштування. Те, що ключ може бачити та змінювати, також обмежується його сферою дії та доступом, до якого він прив’язаний. :::