تخطَّ إلى المحتوى الرئيسي
تصفّح التوثيق

مفاتيح API

أنشئ نوعي المفاتيح اللذين يُصدِرهما Syncanix واعرضهما وألغِهما — مفتاح سرّي لواجهة الأوامر وMCP، ومفتاح قابل للنشر للودجت المضمَّن.

تتيح مفاتيح API لأدواتك الخاصة الوصول إلى مساحة عملك. وهناك نوعان، والفرق بينهما مهمّ: أحدهما سرّ من جانب الخادم، والآخر آمن لتضمينه في صفحة الويب لديك.

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

مفتاح سرّي (gak_…)
كامل الصلاحيات وللخادم فقط. تستخدمه واجهة الأوامر لرفع كتالوجك، ويستخدمه خادم MCP للمصادقة. أبقِه بعيدًا عن أي شيفرة في جانب العميل.
مفتاح قابل للنشر (pk_…)
مخصّص للمحادثة فقط ومقيَّد بالأصل، فيكون آمنًا لتضمينه في مصدر صفحتك — وهو تمامًا ما يستخدمه ودجت المحادثة. يمكنه بدء محادثة لا أكثر.
gak_<env>_<32 base32 chars>   # secret — CLI / MCP, server-side only
pk_<test|live>_<32 base32 chars>  # publishable — embedded in your page

إنشاء مفتاح

تُدار المفاتيح ضمن الإعدادات ← مفاتيح API في لوحة التحكم.

  1. افتح مفاتيح APIانتقل إلى الإعدادات ← مفاتيح API واختر البيئة التي تنشئ المفتاح لها.
  2. اختر النوعأنشئ مفتاحًا سرّيًا لواجهة الأوامر أو MCP، أو مفتاحًا قابلاً للنشر للودجت. وامنحه اسمًا تتعرّف عليه لاحقًا.
  3. انسخه الآنيُعرَض المفتاح كاملاً مرة واحدة فقط. انسخه واحفظه في مكان آمن قبل إغلاق النافذة.

المفاتيح لكل بيئة

ينتمي كل مفتاح إلى بيئة واحدة. فلا يستطيع مفتاح التطوير المساس ببيانات الإنتاج والعكس صحيح، ما يُبقي حركة الاختبار وحركة الإنتاج منفصلتين بوضوح.

إلغاء مفتاح

ألغِ المفتاح من الصفحة نفسها فيتوقّف عن العمل فورًا. وألغِه على الفور إن انكشف يومًا، ثم أنشئ بديلاً. ولا يؤثّر إلغاء مفتاح أبدًا في أي مفتاح آخر.

الحفاظ على أمان المفاتيح

  • احفظ المفاتيح السرّية في مدير أسرار أو متغيّر بيئة — لا في نظام التحكّم بالإصدارات ولا في شيفرة الواجهة الأمامية.
  • المفاتيح القابلة للنشر مصمّمة للواجهة الأمامية — فهي تبدأ المحادثات فقط ومقيَّدة بالأصول التي تسمح بها.
  • دوّر المفاتيح دوريًا: أنشئ الجديد، وحوّل أدواتك إليه، ثم ألغِ القديم.
  • يُسجَّل إنشاء كل مفتاح وإلغاؤه في سجلّ التدقيق الخاص بمساحة عملك.

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