Ana içeriğe atla
LLMs.md

API ve Dışa Aktarmalar

LiteLog'dan diğer sistemlere veri almanın iki yolu vardır:

  1. REST API v1 — LiteLog ile otomatik olarak konuşan üçüncü taraf sistemler için: ör. B. misafirin ödeme yapması sırasında bir temizlik görevi oluşturan bir mülk yönetim sistemi (PMS) veya mülk ana verilerini senkronize eden bir ara yazılım.
  2. CSV ve PDF dışa aktarmaları — bordro, raporlama ve müşterilere gönderme için, kod satırı olmadan. İhracat ve Nakliye'a bakın.

REST API v1​

API anahtarı oluştur​

API anahtarlarını portalda REST API kartındaki Ayarlar → Entegrasyonlar altında yönetebilirsiniz:

  1. Anahtar oluştur seçeneğine tıklayın ve bir ad atayın (ör. "PMS tatil daireleri").
  2. Anahtarın sahip olmasını istediğiniz İzinleri (Kapsamlar) yalnızca gerektiği kadarını seçin.
  3. Ham anahtar (ll_live_…) tam olarak bir kez görüntülenir. Kopyalayın ve güvenli bir şekilde saklayın; bundan sonra anahtarın yalnızca başlangıcı görünecektir.

Entegrasyonlar

İstemcinize ve erişime bir anahtar bağlıdır; bu erişimin gördüğü nesneleri tam olarak görür. İptal derhal yürürlüğe girer; hatasız rotasyon için önce yeni anahtarı oluşturun, üçüncü taraf sistemi dönüştürün ve ardından eskisini iptal edin.

Kimlik doğrulama​

Her istek, anahtarı başlıkta taşır — ya X-Api-Key olarak ya da taşıyıcı belirteci olarak:

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 ilk test olarak uygundur: uç nokta, daha fazla izin gerektirmeden anahtarın içeriğini (istemci, kapsamlar) döndürür.

Uç noktalar​

Yöntem ve yolAmaçGerekli kapsam
GET /api/v1/meTest anahtarı: kendi bağlamı (istemci, kapsamlar)—
GET /api/v1/propertiesNesneleri listelemeproperties:read
POST /api/v1/propertiesNesne oluşturproperties:write
PATCH /api/v1/properties/:idNesneyi güncelleproperties:write
GET /api/v1/tasksGörevleri listeletasks:read
POST /api/v1/tasksGörev oluştur (sağlanan uuid aracılığıyla idempotent)tasks:write
POST /api/v1/incidentsBir rapor oluşturun (olay/kusur).incidents:write
GET /api/v1/form-responsesGönderilen form yanıtlarını sorgula (yoklama)form_responses:read
GET /api/v1/form-responses/:idYanıtlar ve fotoğraf bağlantıları da dahil olmak üzere ayrıntılı yanıt formuform_responses:read

:::tip Idempotenz Görevleri oluştururken, kendi uuid kodunuzu girin; aynı olayın tekrarlanan teslimleri (örneğin, PMS'nizin webhook'un yeniden teslimi) hiçbir zaman iki görev oluşturmayacaktır. :::

Örnek: “Misafir ayrılır → temizlik görevi”​

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

Sınırlar ve Davranış​

  • Hız Sınırı: Anahtar başına dakika başına 120 istek (aşanırsa HTTP 429).
  • Lisans lisansı yok: API erişimleri lisans koltuğunu işgal etmez. Süresi dolmuş bir lisans, yazma erişimini engeller (okuma mümkün kalır, yazarken HTTP 402).
  • Hata biçimi: 401 (Anahtar eksik/geçersiz/iptal edildi), 403 (Kapsam veya nesne erişimi eksik), 404 (Kaynak yok), 409 (Çakışma/Yineleme), 400/422 (Doğrulama hatası - bilinmeyen alanlar reddedildi).
  • Henüz dahil edilmeyenler: Giden web kancaları (planlanan — o zamana kadar GET /api/v1/form-responses?status=submitted aracılığıyla yoklama), OAuth2, yazma süresi takibi veya form yanıtları, dosya yüklemeleri ve DELETE uç noktaları.

CSV ve PDF dışa aktarmaları​

Bordro ve raporlama için bir API'ye ihtiyacınız yoktur; yerleşik dışa aktarmalar en yaygın durumları kapsar:

  • CSV olarak çalışma süreleri - ör. B. Bordro için kişi başına günlük devam matrisi.
  • Raporlar PDF olarak — tur, bildirim ve form raporları, istek üzerine kendi Markalaşma dosyanızda.
  • Yinelenen e-posta teslimi — Otomatik olarak raporlar; B. müşterilere haftalık olarak gönderin.

Tüm ayrıntılar: İhracat ve Nakliye ve Nesne – Nakliye.

İzinler​

:::info Berechtigung API anahtarları oluşturmak ve iptal etmek için Ayarları Düzenle iznine ihtiyacınız vardır. Bir anahtarın görebileceği ve değiştirebileceği şeyler aynı zamanda kapsamı ve bağlı olduğu erişimle de sınırlıdır. :::

İlgili sayfalar​