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