API и экспорт
Есть два способа получить данные из LiteLog в другие системы:
- REST API v1 — для сторонних систем, которые автоматически взаимодействуют с LiteLog: например. B. Система управления недвижимостью (PMS), которая создает задачу по уборке во время выезда гостя, или промежуточное программное обеспечение, которое синхронизирует основные данные недвижимости.
- Экспорт в CSV и PDF — для расчета заработной платы, отчетности и отправки клиентам без единой строки кода. См. Экспорт и доставка.
REST API v1
Создать ключ API
Вы управляете ключами API на портале в разделе Настройки → Интеграции на карточке REST API:
- Нажмите Создать ключ и присвойте имя (например, «Апартаменты для отдыха PMS»).
- Выберите Разрешения (Области действия), которые вы хотите иметь для ключа — ровно столько, сколько необходимо.
- Необработанный ключ (
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 подходит в качестве первого теста: конечная точка возвращает контекст ключа (клиент, области), не требуя дополнительных разрешений.
Конечные точки
| Метод и путь | Цель | Требуемый объем |
|---|---|---|
| КОД0 | Тестовый ключ: собственный контекст (клиент, области действия) | — |
| КОД0 | Список объектов | КОД0 |
| КОД0 | Создать объект | КОД0 |
| КОД0 | Обновить объект | КОД0 |
| КОД0 | Список задач | КОД0 |
| КОД0 | Создать задачу (идемпотентную через предоставленный uuid) | КОД0 |
| КОД0 | Создать отчет (инцидент/дефект). | КОД0 |
| КОД0 | Запрос ответов на отправленные формы (опрос) | КОД0 |
| КОД0 | Подробно формируйте ответ, включая ответы и ссылки на фото. | КОД0 |
:::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, отслеживание времени или ответы в форме, загрузка файлов и удаление конечных точек.
Экспорт CSV и PDF
Вам не нужен API для расчета заработной платы и отчетности — встроенный экспорт охватывает наиболее распространенные случаи:
- Рабочее время в формате CSV — например. B. Матрица ежедневной посещаемости на человека для расчета заработной платы.
- Отчеты в формате PDF — отчеты об экскурсиях, уведомлениях и формах в вашем собственном Брендинг по запросу.
- Периодическая доставка по электронной почте – автоматические отчеты, например Б. отправлять клиентам еженедельно.
Все данные: Экспорт и доставка и Объект — Доставка.
Разрешения
:::info Berechtigung Чтобы создавать и отзывать ключи API, вам необходимо разрешение Редактировать настройки. То, что ключ может видеть и изменять, также ограничено его областью действия и доступом, к которому он привязан. :::