واجهة برمجة التطبيقات والصادرات
هناك طريقتان لنقل البيانات من LiteLog إلى أنظمة أخرى:
- REST API v1 — لأنظمة الجهات الخارجية التي تتحدث تلقائيًا إلى LiteLog: على سبيل المثال. ب. نظام إدارة الممتلكات (PMS) الذي يقوم بإنشاء مهمة تنظيف أثناء تسجيل خروج الضيف، أو برنامج وسيط يقوم بمزامنة البيانات الرئيسية للعقار.
- تصدير ملفات CSV وPDF — لكشوف المرتبات وإعداد التقارير وإرسالها إلى العملاء، بدون سطر من التعليمات البرمجية. انظر التصدير والشحن.
واجهة برمجة تطبيقات REST 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، وتتبع الوقت أو استجابات النماذج، وتحميلات الملفات، ونقاط النهاية DELETE.
تصدير ملفات CSV وPDF
لا تحتاج إلى واجهة برمجة التطبيقات (API) لكشوف المرتبات وإعداد التقارير - تغطي عمليات التصدير المضمنة الحالات الأكثر شيوعًا:
- أوقات العمل بتنسيق CSV — على سبيل المثال. ب. مصفوفة الحضور اليومي للشخص الواحد لكشوف المرتبات.
- التقارير بصيغة PDF — تقارير الجولات والإشعارات والنماذج، في العلامة التجارية الخاصة بك عند الطلب.
- تسليم البريد الإلكتروني المتكرر — التقارير تلقائيًا، على سبيل المثال. ب. إرسال أسبوعيا للعملاء.
كافة التفاصيل: التصدير والشحن وكائن - الشحن.
الأذونات
:::info Berechtigung لإنشاء مفاتيح واجهة برمجة التطبيقات وإبطالها، تحتاج إلى إذن تحرير الإعدادات. إن ما يمكن للمفتاح رؤيته وتغييره محدود أيضًا بنطاقه والوصول إليه. :::