مفاتيح API - وثائق Entity Enricher

مفاتيح API

أنشئ مفاتيح API للوصول البرمجي إلى Entity Enricher. استخدم مفاتيح وصول المؤسسة للتكامل بين الخدمات وخطوط أنابيب CI/CD وسير العمل الآلي.

أنواع المفاتيح

يدعم Entity Enricher نوعين من مفاتيح API، يناسب كل منهما حالات استخدام مختلفة:

موصى به

مفاتيح وصول المؤسسة

مفاتيح مستقلة لها دورها الخاص، غير مرتبطة بأي حساب مستخدم. الخيار الأمثل للتكامل بين الخدمات.

  • لهم دورهم الخاص (مالك أو محرّر أو مشغّل)
  • غير متأثر بتغييرات حساب المستخدم
  • مقيّد بالمؤسسة
  • يتطلب دور المالك للإنشاء

مفاتيح المستخدم القديمة

مفاتيح مرتبطة بحساب مستخدم محدد. ترث دور منشئها وتتأثر بتغييرات حساب المستخدم.

  • توريث دور المستخدم المُنشئ
  • إذا تم إلغاء تنشيط المستخدم، يتوقف المفتاح عن العمل
  • يمكن لأي مستخدم مُصادَق عليه إنشاء واحد

تنسيق المفتاح وأمانه

الصيغة:ent_a1b2c3d4e5f6g7h8

تستخدم المفاتيح البادئة ent_ متبوعةً ببايتات عشوائية. ويُعرض المفتاح الكامل مرة واحدة فقط عند الإنشاء — إذ لا يمكن استرجاعه لاحقاً.

مفاتيح الوصول (لاستدعاء API الخاص بـ Entity Enricher) تُخزَّن كتجزئات SHA256 في قاعدة البيانات، لذا حتى مع الوصول إلى قاعدة البيانات، لا يمكن استعادة المفتاح الأصلي. تُخزَّن أول 12 حرفًا فقط (البادئة) كنص عادي لأغراض التعريف.

مفاتيح المزوّد (مفاتيح API الخاصة بالـ LLM مثل Anthropic وOpenAI) مشفَّرة أثناء التخزين باستخدام تشفير Fernet المتماثل (AES-128-CBC + HMAC). يجب أن تكون قابلة لفك التشفير أثناء التشغيل للمصادقة مع مزوّدي الـ LLM. تُخزَّن الأحرف الأربعة الأخيرة فقط كنص عادي.

جارٍ إنشاء مفاتيح API

أنشئ المفاتيح من صفحة مفاتيح API في التطبيق، أو برمجيًا عبر REST API:

تكوين المفتاح

الحقلالوصف
الاسماسم وصفي للتعريف (مثل "CI/CD Pipeline"، "n8n Integration")
الدورمستوى الإذن: مالك، أو محرّر، أو مُشغّل. يحدّد ما يمكن للمفتاح الوصول إليه.
النطاقاتقراءة أو كتابة أو كلاهما. يتحكم في ما إذا كان بإمكان المفتاح تعديل البيانات أم قراءتها فقط.
انتهاء الصلاحيةتاريخ انتهاء اختياري. تظل المفاتيح بدون تاريخ انتهاء صالحة حتى إلغائها.

استخدام مفاتيح API

أرسل مفتاح API الخاص بك في ترويسة X-API-Key مع كل طلب:

curl -H "X-API-Key: ent_your_key_here" \
     https://your-instance.example.com/api/enrichment/options

طرق المصادقة

الطريقةالترويسةحالة الاستخدام
مفتاح APIX-API-Key: ent_...من خدمة إلى خدمة، CI/CD، الأتمتة
رمز BearerAuthorization: Bearer <jwt>عملاء الويب، الجلسات التفاعلية

الوصول إلى نقاط النهاية حسب الدور

يحدد دور مفتاح API نقاط النهاية التي يمكنه الوصول إليها:

فئة نقطة النهايةالحد الأدنى للدور
الإثراء (فردي، دُفعة)مُشغِّل
السجلات (عرض، تفاصيل، حذف)مُشغِّل
المخطط (قراءة)مُشغِّل
المخطط (إنشاء، تحرير، حذف)المحرّر
الدمجمُشغِّل
معلومات المزوّدمُشغِّل
تحليلات التكلفةمُشغِّل
إدارة مفاتيح APIالمالك
إدارة المستخدمينالمالك

إدارة المفاتيح

توفر صفحة مفاتيح API عرضًا كاملاً لجميع مفاتيح المؤسسة مع إحصاءات الاستخدام:

عرض الاستخداماطّلع على وقت آخر استخدام والعدد الإجمالي للاستخدام لكل مفتاح
تحديث الدورتغيير دور مفتاح وصول المؤسسة (للمالك فقط)
إبطالتعطيل مفتاح نهائيًا. لا يمكن إعادة تنشيط المفاتيح الملغاة.
انتهاء الصلاحيةيتم تمييز المفاتيح التي تنتهي صلاحيتها خلال 7 أيام. أما المفاتيح منتهية الصلاحية فتُرفض تلقائياً.

مفاتيح المزوّد مقابل مفاتيح الوصول

تحتوي صفحة مفاتيح API على عدة علامات تبويب تخدم أغراضًا مختلفة:

مفاتيح المزوّد

مفاتيح API لمزوّد LLM الخاص بمؤسستك (Anthropic، OpenAI، إلخ) للفوترة المستقلة. يدعم مفاتيح متعددة لكل مزوّد مع تدوير LRU تلقائي. راجع النماذج والأسعار لنظام BYOK.

تُشفَّر مفاتيح المزوّد أثناء التخزين باستخدام تشفير Fernet المتماثل (AES-128-CBC مع مصادقة HMAC). ولا تُفكّ تشفيرها إلا أثناء التشغيل عند إجراء نداءات API الخاصة بـ LLM. ولا تُخزَّن سوى آخر 4 أحرف بنصّ صريح لأغراض العرض.

المفاتيح العامة

مفاتيح مزوّدي LLM على مستوى النظام يديرها المسؤولون. تُستخدم كخيار احتياطي عند عدم توفر مفتاح للمؤسسة. يدعم عدة مفاتيح لكل مزوّد مع تدوير LRU والتعطيل التلقائي عند الأعطال الدائمة.

مفاتيح وصول المؤسسة

مفاتيح للوصول إلى API الخاص بـ Entity Enricher. تستخدمها الأنظمة الخارجية لاستدعاء نقاط نهاية الإثراء والمخطط والسجلات وغيرها برمجياً. راجع مرجع API للاطلاع على توثيق نقاط النهاية.

الخطوات التالية