Kibi API

تسمح واجهة برمجة تطبيقات Kibi REST للتطبيقات الخارجية ومساعدي الذكاء الاصطناعي وأتمتة العمليات بالوصول إلى بيانات Kibi Connect. من خلال واجهة البرمجة هذه، يمكن قراءة المحتوى وكتابته - من صفحات الويكي إلى منشورات الأخبار والمهام ومداخل التقويم.

#تفعيل وصول واجهة برمجة التطبيقات

يجب تفعيل واجهة برمجة التطبيقات REST أولاً من قبل مشرف النظام. يوجد الإعداد تحت:

الإعدادات → التكاملات → واجهة برمجة التطبيقات REST

يتوفر هنا الخيارات التالية:

تفعيل واجهة برمجة التطبيقات REST

تشغيل أو إيقاف واجهة البرمجة.
تقييد إنشاء الرموز المميزة على أدوار معينة

عند التفعيل، يمكن للمستخدمين الذين لديهم الأدوار المحددة فقط إنشاء رموز مميزة لواجهة البرمجة. بالإضافة إلى ذلك، يمكن تفويض مستخدمين فرديين من خلال وصول الوظيفة في علامة تبويب الأمان في ملفهم الشخصي.
تفعيل تقييد عنوان IP

عند التفعيل، يمكن فقط لعناوين IP المحددة الوصول إلى واجهة البرمجة. هذا مستوى أمني إضافي.

لقطات شاشة: إعدادات واجهة البرمجة تحت التكاملات

#إنشاء رمز مميز لواجهة البرمجة

يمكن لكل مستخدم إنشاء رموز مميزة خاصة به لواجهة البرمجة من خلال ملفه الشخصي. للقيام بذلك، انتقل إلى:

ملف المستخدم الشخصي → التكاملات → إنشاء رمز مميز جديد

عند إنشاء رمز مميز، يمكنك تعيين:

الاسم

اسم وصفي (مثل "وكيل الذكاء الاصطناعي" أو "تكامل ERP" أو "أتمتة سير العمل").
الأذونات (نطاقات)

اختر فقط الأذونات التي يحتاجها التكامل فعليًا (مبدأ أقل امتياز).
تاريخ انتهاء الصلاحية (اختياري)

يمكن تعيين تاريخ انتهاء صلاحية اختياري، بعد ذلك يصبح الرمز المميز غير صالح تلقائيًا.

لقطات شاشة: نموذج إنشاء الرمز المميز مع النطاقات

#حفظ الرمز المميز بشكل آمن

بعد الإنشاء، يتم عرض قيمة الرمز المميز مرة واحدة فقط. انسخها فورًا وحفظها بشكل آمن (مثلاً في مدير كلمات المرور). في حال فقدانها، يجب إبطال الرمز المميز وإنشاء رمز جديد.

لقطات شاشة: الرمز المميز بعد الإنشاء - مرئي مرة واحدة فقط

#الأذونات المتاحة (نطاقات)

تتحكم النطاقات التالية في وصول الرمز المميز لواجهة البرمجة إلى مناطق مختلفة:

النطاق	الوصف
`posts:read`	قراءة المنشورات والأخبار المنشورة
`posts:write`	إنشاء المنشورات وتحديثها وحذفها
`wiki:read`	قراءة صفحات الويكي والتوثيق
`wiki:write`	إنشاء صفحات الويكي وتحديثها
`calendar:read`	قراءة مداخل التقويم
`calendar:write`	إنشاء مداخل التقويم وتحديثها وحذفها
`groups:read`	قراءة المجموعات العامة والأعضاء والمنشورات والملفات
`surveys:read`	قراءة الاستبيانات والنتائج
`tasks:read`	قراءة المهام (المهام الخاصة أو المخصصة فقط)
`tasks:write`	إنشاء المهام وتحديثها
`users:read`	قراءة دليل المستخدمين العام (بدون بيانات خاصة)
`chat:read`	قراءة المحادثات والرسائل
`chat:write`	إرسال رسائل (للروبوتات والأتمتة)
`notifications:read`	قراءة إشعارات المستخدم
`notifications:write`	إرسال إشعارات للمستخدمين (بما في ذلك الإشعارات الفورية)
`search`	البحث عبر الكيانات

#مصادقة واجهة البرمجة

يجب أن ترسل جميع طلبات واجهة البرمجة الرمز المميز كرمز حامل في رأس الترخيص:

curl -H "Authorization: Bearer kbc_IhrTokenHier" \
     https://ihre-firma.kibi.de/api/v1/wiki

عنوان URL الأساسي لواجهة البرمجة هو: https://ihre-firma.kibi.de/api/v1

#نقاط النهاية المتاحة

توثيق واجهة البرمجة الكامل مع جميع نقاط النهاية والمعلمات متاح مباشرة في Kibi Connect تحت:

التوثيق التفاعلي: ملف المستخدم الشخصي → التكاملات → توثيق واجهة البرمجة
مواصفات OpenAPI (JSON): ملف المستخدم الشخصي → التكاملات → OpenAPI JSON

نظرة عامة على أهم نقاط النهاية:

المجال	نقطة النهاية	الوصف
الويكي	`GET /wiki`	سرد صفحات الويكي
الويكي	`POST /wiki`	إنشاء صفحة ويكي
الأخبار	`GET /posts`	سرد المنشورات
المهام	`GET /tasks`	سرد المهام
التقويم	`GET /calendar/events`	سرد مداخل التقويم
الدردشة	`POST /chat/direct`	إرسال رسالة مباشرة
المستخدمون	`GET /users`	سرد دليل المستخدمين
البحث	`GET /search`	البحث النصي الكامل عبر الكيانات

#إدارة الرموز المميزة

جميع الرموز المميزة التي تم إنشاؤها تظهر في نظرة عامة تحت ملف المستخدم الشخصي → التكاملات. هنا يمكنك رؤية:

اسم الرمز المميز
الأذونات المخصصة
متى تم استخدام الرمز المميز آخر مرة
إمكانية إبطال الرمز المميز

لقطات شاشة: نظرة عامة على الرموز المميزة مع الرموز النشطة

#ملاحظات مهمة

وصول البيانات: رموز واجهة البرمجة لها وصول فقط إلى البيانات التي يمكن للمستخدم المعني الوصول إليها. لا تزال صلاحيات المستخدم سارية.
الأمان: لا تشارك رموز واجهة البرمجة علنًا أبدًا. قم بتخزين الرموز في متغيرات البيئة أو مدير الأسرار، وليس في رمز المصدر.
مبدأ أقل امتياز: منح فقط الأذونات الضرورية الحد الأدنى. لا يحتاج الرمز المميز لتكامل الويكي إلى الوصول إلى الدردشة.
تاريخ انتهاء الصلاحية: ضع تاريخ انتهاء صلاحية للتكاملات المؤقتة لزيادة الأمان.
الإبطال: أبطل الرموز المميزة غير اللازمة فورًا من خلال نظرة عامة على الرموز.