توثيق Syncanix
كل ما تحتاجه لاكتشاف واجهة برمجة التطبيقات (API) لديك، وتضمين أداة الدردشة، وربط عميل MCP، وإطلاق مساعد ذكاء اصطناعي ينفّذ إجراءات حقيقية لمستخدميك — مستضاف في الاتحاد الأوروبي وبست لغات.
مقدمة
- ما هو Syncanix؟يحوّل Syncanix واجهة برمجة التطبيقات الحالية لديك إلى مساعد ذكاء اصطناعي يمكن لمستخدميك التحدث إليه — مضمّن في تطبيقك ومتاح لعملاء الذكاء الاصطناعي عبر MCP.
- كيف يعمل Syncanixمن أمر اكتشاف واحد إلى مساعد يعمل فعليًا: كيف يربط كتالوج القدرات بين أداة سطر الأوامر والأداة وواجهة الدردشة وخادم MCP.
- نظرة عامة على البنيةكيف يربط Syncanix بين مستخدميك وواجهة برمجة التطبيقات لديك والذكاء الاصطناعي — وأين يعمل كل ذلك.
- اللغات و RTLيعمل Syncanix بست لغات بشكل أصيل، مع دعم كامل للكتابة من اليمين إلى اليسار للعربية والعبرية.
- المسردالمصطلحات الأساسية المستخدَمة في توثيق Syncanix.
البدء
المفاهيم الأساسية
- كتالوج القدراتالقائمة المنظَّمة بما تستطيع واجهة برمجة التطبيقات لديك القيام به — تُكتشَف مرة واحدة، وتحرّرها أنت، وتقرؤها كل الواجهات.
- المتصفّح هو البوابةنموذج أمان Syncanix في فكرة واحدة: الذكاء الاصطناعي لا يحتفظ ببيانات اعتماد مستخدميك أبدًا.
- الهوية والمصادقةيستخدم Syncanix مزوّد الهوية الحالي لديك — ولا يصبح أبدًا مخزن كلمات مرور مستخدميك.
- تأكيد الإجراءات والخطورةكيف يقرّر Syncanix ما يُنفَّذ تلقائيًا وما يحتاج إلى موافقة بشرية.
- أنماط العرضكيف يعرض المساعد النتائج — مكوّنات مدمجة، أو مكوّناتك الخاصة، أو نقل المستخدم إلى الصفحة الصحيحة.
- الموثوقية وتوجيه النماذجكيف يواصل Syncanix الإجابة: عدة مزوّدي نماذج، ومفاتيحك الخاصة، وتوجيه داخل الاتحاد الأوروبي.
- الذاكرة والمعرفةبماذا يتذكّر المساعد عبر الجلسات، والمعرفة التي يعتمد عليها في الإجابة.
CLI
- أداة سطر الأوامر في Syncanixاكتشف واجهة برمجة التطبيقات لديك وأدِر كتالوجك من سطر الأوامر — دون تثبيت.
- syncanix initاكتشف واجهة برمجة التطبيقات لديك، وابنِ كتالوج القدرات، وارفعه — مع إثراء بالذكاء الاصطناعي مشروط بالموافقة.
- مزيد من أوامر الأداةسجّل الدخول، واستورد مخطّطًا، وشغّل البيئة المحلية، وشخّص، وسجّل خادم MCP خارجيًا، وطبّق طبقات الكتالوج.
- ملفات الإعدادالملفات التي تقرؤها الأداة وتكتبها: قواعد التجاهل، وإعداد الأداة، والكتالوج، وسجلّ موافقتك، وبيانات الاعتماد، وطبقة الكتالوج.
- متغيّرات البيئة ورموز الخروجمتغيّرات البيئة التي تقرؤها الأداة ورموز الخروج التي تُرجِعها.
- دعم أُطر العملاللغات وأُطر العمل التي تستطيع أداة الاكتشاف قراءتها تلقائيًا — وماذا تفعل حين لا يكون إطارك من بينها.
أدلة أُطر العمل
- Syncanix مع Expressاجعل واجهة Express البرمجية جاهزة للوكلاء: ما يقرأه الاكتشاف، وكيف تشغّله، وكيف تُطلق واجهة الدردشة وخادم MCP.
- Syncanix مع NestJSاجعل واجهة NestJS البرمجية جاهزة للوكلاء: ما يقرأه الاكتشاف، وكيف تشغّله، وكيف تُطلق واجهة الدردشة وخادم MCP.
- Syncanix مع Next.jsاجعل تطبيق Next.js جاهزًا للوكلاء: ما يقرأه الاكتشاف، وكيف تشغّله، وكيف تُطلق واجهة الدردشة وخادم MCP.
- Syncanix مع Fastifyاجعل واجهة Fastify البرمجية جاهزة للوكلاء: ما يقرأه الاكتشاف، وكيف تشغّله، وكيف تُطلق واجهة الدردشة وخادم MCP.
- Syncanix مع FastAPIاجعل خدمة FastAPI جاهزة للوكلاء: ما يقرأه الاكتشاف، وكيف تشغّله، وكيف تُطلق واجهة الدردشة وخادم MCP.
- Syncanix مع Djangoاجعل مشروع Django جاهزًا للوكلاء: ما يقرأه الاكتشاف، وكيف تشغّله، وكيف تُطلق واجهة الدردشة وخادم MCP.
- Syncanix مع Railsاجعل واجهة Rails البرمجية جاهزة للوكلاء: ما يقرأه الاكتشاف، وكيف تشغّله، وكيف تُطلق واجهة الدردشة وخادم MCP.
- Syncanix مع Laravelاجعل واجهة Laravel البرمجية جاهزة للوكلاء: ما يقرأه الاكتشاف، وكيف تشغّله، وكيف تُطلق واجهة الدردشة وخادم MCP.
لوحة التحكم
- لوحة التحكمحيث تضبط مساحة عملك — الكتالوج، والشخصية، والمعرفة، والتصميم، والفريق، والفوترة — في مكان واحد.
- الكتالوج والقدراتتصفّح القدرات المكتشَفة وحسِّن كلًا منها — وصفها، وصلاحياتها، وخطورتها، والمزيد.
- نقاط النهاية المخصّصة وتوفّر الأدواتأضِف قدرات يستطيع المساعد استدعاءها إلى جانب مساراتك المكتشَفة، وتحكّم في أي المستخدمين تُعرَض عليهم كل أداة.
- الموجِّهات والشخصيةامنح المساعد صوتًا، وموجِّه نظام، وسلوكًا واضحًا للاحتياط والرفض.
- المعرفة والمستنداتاربط مصادر محتوى كي يستطيع المساعد الإجابة من توثيقك، واضبط ما يسترجعه.
- التصميم واستوديو تصميم الأداةصمّم الأداة لتلائم هويتك التجارية — رموز السمة، والمكوّنات، واستوديو التصميم لكل مؤسسة.
- المراقبة والتكلفة والتدقيقاطّلع على أداء المساعد، وكم يكلّف، وسجلٍّ كامل لما حدث.
- البيئات والترقيةأعِدّ الأمور بأمان في التطوير، ثم رقِّ إلى الإنتاج خلف بوابة تقييم.
- الفريق والأدوارادعُ فريقك وامنح كل شخص مستوى الوصول المناسب عبر خمسة أدوار واضحة.
- الإعداداتالمفاتيح، والأصول، ومفاتيح النماذج الخاصة بك، واتحاد الهوية، والحدود، والفوترة، والخصومات.
الأداة (Widget)
- الأداةضمّن أداة الدردشة من Syncanix في تطبيقك بوسم سكربت واحد — معزولة، ومؤجَّلة التحميل، وملائمة لهويتك.
- إعداد الأداةاضبط الأداة بسمات data-* على وسم السكربت.
- واجهة وقت تشغيل الأداةتحكّم في الأداة من JavaScript عبر كائن window.syncanix.
- تنسيق الأداةتلائم الأداة هويتك التجارية تلقائيًا، مع تحكّم كامل متى شئت.
- الأحجام والأوضاعتأتي الأداة بخمسة أحجام ووضعَي تخطيط — اختر ما يناسب كل موضع تستخدمها فيه.
- تجربة الدردشةما يراه مستخدموك في محادثة — ردود متدفّقة، واقتراحات، وبطاقات إجراء، وإفصاحات، والمزيد.
- الـ SDK بلا واجهةابنِ واجهة دردشة مخصّصة بالكامل فوق Syncanix، دون تركيب الأداة.
- إمكانية الوصول و RTLتستوفي الأداة WCAG 2.1 AA وتُرتَّب على نحوٍ صحيح في لغات الكتابة من اليمين إلى اليسار.
خادم MCP
- خادم MCPتحصل كل مساحة عمل على خادم MCP خاص بها، كي تصل عملاء الذكاء الاصطناعي مثل Claude Desktop وCursor وChatGPT إلى قدراتك.
- ربط عميلاربط Claude Desktop وCursor وChatGPT وعملاء MCP آخرين بمساحة عملك.
- كيف يعمل تسجيل الدخول في MCPيصادق عملاء MCP باستخدام OAuth 2.1، متّحدين مع مزوّد الهوية لديك — ولا يحتفظ Syncanix ببيانات اعتماد مستخدميك أبدًا.
- الأدوات والتنفيذما الذي يعرضه خادم MCP، وكيف تُعلَّم الأدوات الخطرة، وكيف تُنفَّذ الاستدعاءات فعليًا.
- حدود MCP ونقاط نهايتهحدود الجلسة ونقاط نهاية OAuth والنقل التي يعرضها خادم MCP.
المصادقة والوصول
- المصادقة والوصولكيف يسجّل الأشخاص الدخول إلى Syncanix — فريقك إلى لوحة التحكم ومستخدموك إلى المحادثة — إضافةً إلى المفاتيح وموفّري الهوية والضمانات التي تربط بينهم.
- تسجيل الدخول ومساحات العملكيف تسجّل أنت وفريقك الدخول إلى لوحة تحكم Syncanix، وكيف تُبقي مساحات العمل عمل كل حساب منفصلاً بوضوح.
- مصادقة مستخدميكالطرق الأربع التي يمكن بها للودجت مصادقة مستخدميك النهائيين، وكيف تختار ما يناسب منظومتك التقنية.
- ربط موفّر هويةاربط Auth0 أو Clerk أو Amazon Cognito أو WorkOS في لوحة التحكم كي يتمكّن Syncanix من مصادقة مستخدميك النهائيين عبر الموفّر الذي تستخدمه أصلاً.
- مفاتيح APIأنشئ نوعي المفاتيح اللذين يُصدِرهما Syncanix واعرضهما وألغِهما — مفتاح سرّي لواجهة الأوامر وMCP، ومفتاح قابل للنشر للودجت المضمَّن.
- التحقق الإضافي وأمان الإجراءاتكيف يصنّف Syncanix كل إجراء على أنه قراءة أو كتابة أو إجراء مدمِّر — وضوابط التأكيد وإعادة التحقّق والتراجع التي تحمي كلًّا منها.
الفوترة والخطط
- الفوترة والخططكيف تتقاضى Syncanix الرسوم: خطط لك ل مساحة عمل، وقياس حسب المستخدمين النهائيين، واشتراكات، واستخدام مفتاح النموذج الخاص بك، والحدود التي تبقي الاستهلاك قابلاً للتوقع.
- الخططخطط Syncanix الخمس — Dev وStarter وGrowth وScale وEnterprise — إضافةً إلى الفترات التجريبية والفوترة السنوية وخصومات المنظمات غير الربحية والتعليم والمصادر المفتوحة.
- الاستخدام والقياسكيف تقيس Syncanix الاستخدام بالمستخدمين النهائيين النشطين شهرياً (MAEU)، وكيف يعمل العدّ، وماذا يحدث عند بلوغ حدّك، وأين تتابعه.
- إدارة اشتراككابدأ خطة Syncanix أو غيّرها أو ألغِها، وأدِر وسيلة الدفع عبر بوابة الفوترة من Paddle، واعثر على فو اتيرك وإيصالاتك.
- أحضِر مفتاحك الخاص (BYOK)استخدم مفتاح Anthropic أو OpenAI الخاص بك بحيث يفوتر مزوّدك استخدام النموذج مباشرةً دون أي هامش من Syncanix. المفاتيح للكتابة فقط ومشفّرة في حالة السكون.
- حدود المعدّل وسقوف الإنفاقالضوابط التي تبقي استخدام Syncanix قابلاً للتوقع: حدود معدّل على مستوى المنصة تحمي الاستقرار، وسقوف إنفاق تضبطها أنت لتبقى ضمن ميزانيتك.
الثقة والخصوصية والامتثال
- الثقة والخصوصية والامتثالكيف تحمي Syncanix بياناتك وبيانات مستخدميك النهائيين: إقامة البيانات في الاتحاد الأوروبي، وعزل المستأجرين، وما نعالجه ونحتفظ به، وحقوق خصوصيتك، وبرنامج الامتثال لدينا، وشفافية الذكاء الاصطناعي.
- إقامة البيانات والأمانتعمل Syncanix بالكامل في AWS eu-central-1 (فرانكفورت)، وتعزل بيانات كل عميل على أربع طبقات، وتشفّر البيانات أثناء النقل وفي حالة السكون.
- التعامل مع البيانات والاحتفاظ بهاما البيانات التي تعالجها Syncanix، وكيف يعمل عدم الاحتفاظ بالبيانات (ZDR) مع مزوّدي النماذج، وما الذي ترسله أداة سطر الأوامر للاكتشاف، ومدة الاحتفاظ بالبيانات.
- الخصوصية وحقوقككيف يتم التحكم في ذاكرة المساعد، وكيف تُعالَج البيانات الشخصية، وكيف يمكنك أنت ومستخدموك النهائيون ممارسة حقوق اللائحة العامة لحماية البيانات وCCPA عبر نموذج طلب البيانات.
- الامتثال والمعالجون الفرعيونبرنامج الامتثال لدى Syncanix: دعم اللائحة العامة لحماية البيانات وCCPA مع توفّر اتفاقية معالجة البيانات، وSOC 2 وISO 27001 قيد الإنجاز، والمعالجون الفرعيون الذين نعتمد عليهم.
- شفافية الذكاء الاصطناعيكيف تُفصح Syncanix عن استخدام الذكاء الاصطناعي للمستخدمين النهائيين بكل لغة، وأي النماذج تشغّل المساعد، وكيف تُبنى الإجابات على محتواك.
الأدلة
- الأدلةإرشادات موجَّهة بالمهام تجمع وثائق المرجع في أعمال كاملة — إطلاق الأداة، وربط عميل ذكاء اصطناعي، وبناء الإجابات، والتصرف نيابةً عن مستخدم، والانتقال إلى الإنتاج.
- أضِف أداة الدردشة إلى موقعكانتقل من شيفرتك إلى أداة دردشة مباشرة: اكتشف واجهة برمجة التطبيقات لديك بأداة سطر الأوامر، وراجع الكتالوج، وصمّم الأداة، وادمج المقتطف.
- اربط عميل ذكاء اصطناعي بمساحة عملكاربط Claude Desktop أو Cursor أو ChatGPT بخادم MCP الخاص بك في Syncanix حتى يتمكن عميل ذكاء اصطناعي من استخدام واجهة برمجة التطبيقات لديك نيابةً عنك.
- ابنِ الإجابات على محتواكأضِف وثائقك ومحتواك ليجيب المساعد من موادك بدلاً من التخمين، وتأكّد من أنه يعمل.
- دع المساعد يتصرف نيابةً عن مستخدم مسجَّل الدخولاسمح للمساعد بتنفيذ إجراءات موثَّقة نيابةً عن مستخدم نهائي مسجَّل الدخول، مقيَّدة بصلاحياته، مع تأكيد قبل الإجراءات الحساسة.
- حافظ على حداثة الكتالوجأعد تشغيل الاكتشاف عندما تتغير واجهة API، وادمجه في CI، ودع كشف الانحراف أثناء التشغيل يلتقط ما تسرّب.
- تصدير البيانات ومحوهاكيف تعمل طلبات أصحاب البيانات مع Syncanix — تقديم طلبات الوصول والتصدير والمحو، ومُهَل الاستجابة، ومن يتولى ماذا.
- انتقل إلى الإنتاجانقل مساعدك من الاختبار إلى المباشر: بدّل إلى بيئة الإنتاج، وأنشئ مفاتيح مباشرة، وحدِّد الأصول المسموح بها، واختر خطة، وفعّل الضوابط.
- استكشاف الأخطاءحلول تبدأ من العرض الظاهر للمشكلات التي نراها فعلًا: ودجت محجوب، وطلب أول بطيء، وإخفاقات في الاكتشاف، وفشل في الإثراء، ومشكلات تسجيل الدخول.
المرجع
- المرجعمرجع موحَّد: حقائق سريعة، وصيغ المفاتيح والمعرّفات، وحدود المنصة وقيمها الافتراضية، وإح الات إلى مرجع أداة سطر الأوامر، ومرجع MCP، ودعم أطر العمل، والمسرد.
- المفاتيح والرموز والمعرّفاتمرجع موحَّد لصيغ بيانات الاعتماد والمعرّفات المستخدمة في Syncanix: مفاتيح واجهة برمجة التطبيقات السرية والقابلة للنشر، ورموز اتصال MCP، والبيئات.
- الحدود والقيم الافتراضيةمرجع واحد للحقائق العابرة للمنصة: منطقة البيانات، والاحتفاظ بالسجلات، واستجابات حد المعدّل، ووحدة القياس، وسقوف الإنفاق، واللغات المدعومة.
- مرجع واجهة برمجة التطبيقات في وقت التشغيلعقود وقت التشغيل من جهة العميل: ترويسة النية الموقّعة التي يتحقق منها خادمك، وعقد التصرف-باسم-المستخدم الذي يلاحظه، وشكل بيانات الشاهد.