مفاتيح 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. تُخزَّن الأحرف الأربعة الأخيرة فقط كنص عادي.

  1. 1استدعاء curl جاهز والمفتاح مُضمَّن في الترويسة
جسم المفتاح مُخفى في لقطة الشاشة هذه عن قصد. لا تحتفظ قاعدة البيانات إلا بالبادئة ent_ وبصمة تجزئة، لذا فإن أي مفتاح لم يُنسخ هنا يُستبدل ولا يُسترجع أبدًا.

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

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

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

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

استخدام مفاتيح 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>عملاء الويب، الجلسات التفاعلية
OAuth 2.1Authorization: Bearer <access_token>الموصّلات وعملاء الذكاء الاصطناعي — تفويض قابل للإلغاء لكل تطبيق، لا مفتاح مشترك

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

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

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

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

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

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

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

تضم صفحة مفاتيح API خمس علامات تبويب تخدم أغراضًا مختلفة — أربع منها متاحة للجميع، إضافةً إلى المفاتيح العامة لمسؤولي النظام:

  1. 1مفاتيح مزوّدي LLM الخاصة بمؤسستك
  2. 2مجمّع الاحتياط المشترك — لمسؤولي النظام فقط
  3. 3المفاتيح التي تستدعي API الخاص بـ Entity Enricher
تحتوي أول علامتَي تبويب على المفاتيح التي يستخدمها Entity Enricher للوصول إلى LLM؛ بينما تحتوي الثلاث الأخيرة على بيانات اعتماد تستخدمها أنظمة أخرى للوصول إلى مؤسستك. لا تذكر الصفحة ذلك أبدًا، لكن هذا الاتجاه هو ما يحدّد علامة التبويب التي ينتمي إليها المفتاح.

مفاتيح مزوّدي الذكاء الاصطناعي

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

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

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

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

مفاتيح الوصول إلى التطبيق

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

التطبيقات المتصلة

التطبيقات التي منحتها إذنًا عبر OAuth 2.1 — دليل موصّلات claude.ai، وClaude Desktop، واتصالات Make وn8n. كل صف هو تفويض قابل للإلغاء لا سرٌّ مشترك: إلغاؤه هنا يُبطل رموز ذلك التطبيق دون المساس ببقية تكاملاتك. كما يمكن للمالكين تسجيل عميل OAuth لمثيل n8n مستضاف ذاتيًا.

أنفاق Ollama

بيانات اعتماد نفق Ollama ذاتي الخدمة، الذي يتيح للمنصة الوصول إلى Ollama محلي دون فتح أي منفذ. راجع دليل نفق Ollama.

  1. 1من منح التصريح — يحمل التفويض دور ذلك العضو
  2. 2الواجهة التي يمكن للرمز استخدامها: REST API أو MCP أو كلاهما
  3. 3إبطال تطبيق واحد يُبقي سائر الاتصالات مسجّلة الدخول
علامة تبويب التطبيقات المتصلة: صف لكل تطبيق مُصرَّح به ولكل عضو، بحيث يستطيع الشخص نفسه ربط claude.ai ونسخة n8n بشكل منفصل. وعمود آخر استخدام هو ما يدلّك على الموصّل الذي لا يزال يعمل قبل إبطاله.

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