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

بدء سريع

من واجهة برمجة التطبيقات الحالية لديك إلى مساعد يعمل في تطبيقك — في نحو 90 دقيقة.

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

قبل أن تبدأ

  • مساحة عمل Syncanix — سجّل في app.syncanix.com.
  • Node.js الإصدار 20 أو أحدث.
  • واجهة برمجة تطبيقات HTTP قائمة فيها نقطة نهاية واحدة على الأقل مُصادَق عليها.
  • مزوّد هوية لمستخدميك — Auth0 أو Clerk أو Cognito أو WorkOS أو OIDC الخاص بك.
  • مفتاح Anthropic أو OpenAI أو AWS Bedrock-EU — أو استخدم الوصول المُدار إلى النموذج، وهو مُضمَّن في خطتك.

جهّز مساحة عملك ومفاتيحك

ترفع أداة سطر أوامر الاكتشاف إلى مساحة عمل Syncanix، وتُصادِق الأداة القابلة للتضمين بمفتاح قابل للنشر — لذا أنشئ مساحة العمل واحصل على المفتاحين قبل تشغيل أي شيء.

  1. أنشئ مساحة عملكسجّل في app.syncanix.com. لوحة التحكم هي موطن الكتالوج ومفاتيح API وإعدادات الأداة لديك.
  2. خزّن مفتاح CLI الخاص بكشغّل npx syncanix login والصق المفتاح السرّي (gak_…) الظاهر تحت الإعدادات ← مفاتيح API. تحفظه أداة سطر الأوامر في ~/.syncanix/credentials كي يتمكّن init من رفع الكتالوج الخاص بك.
  3. انسخ مفتاحك القابل للنشرمن الإعدادات ← مفاتيح API في لوحة التحكم، انسخ مفتاحك القابل للنشر (pk_live_…). يستخدمه مقطع تضمين الأداة قيمةً لـ data-key — ومن الآمن شحنه في المتصفح.
npx syncanix login

1. اكتشف واجهة برمجة التطبيقات لديك

شغّل أداة سطر الأوامر في مشروعك. تكتشف إطار العمل لديك، وتقرأ مساراتك، وتكتب كتالوج قدرات وترفعه. الاكتشاف ثابت افتراضيًا — فهو يقرأ شيفرتك ولا يشغّلها، ولا تغادر أي بيانات إنتاجية جهازك.

npx syncanix init

لا يعمل الإثراء الاختياري بالذكاء الاصطناعي (عناوين وأوصاف أوضح) إلا بعد منحك موافقة صريحة على عدم الاحتفاظ بالبيانات عند المطالبة. ويمكنك أيضًا تخطّيه والإثراء لاحقًا.

2. راجع الكتالوج

افتح لوحة التحكم لرؤية ما اكتُشِف. هنا تقرّر ما الذي يستطيع المساعد فعله، وبأي قدر من الحذر:

  • حدِّد نقاط النهاية الداخلية كي تبقى بعيدة عن متناول المساعد.
  • حدِّد أثر كل إجراء — قراءة أو كتابة أو إجراء مدمِّر — وهو ما يتحكّم في كيفية تأكيده.
  • اشترط المصادقة المعزَّزة على الإجراءات الحسّاسة، كي يعيد المستخدم تأكيد هويته قبل تنفيذها.

3. اربط خادمك (اختياري)

عند إضافتها، ثبّت SDK في الخدمة التي تملك واجهة API لديك. تبدأ خلال أجزاء من الثانية وتُبقي كتالوجك محدَّثًا عبر اكتشاف الانحراف أثناء التشغيل:

npm install @syncanix/sdk-node
import { init } from '@syncanix/sdk-node';

// Resolves your API key from SYNCANIX_API_KEY, ~/.syncanix/credentials,
// or an inline { apiKey } — in that order.
const { environment, bootDurationMs } = await init({ environment: 'development' });
console.log(`Syncanix booted in ${bootDurationMs.toFixed(1)}ms`);

يمكنك أيضًا تسجيل أدوات أصيلة في الـ SDK — إجراءات يستطيع المساعد استدعاءها وليست مسارات HTTP عادية. وتُنفَّذ كل منها بهوية المستخدم النهائي التي يوفّرها مزوّد الهوية لديك:

import { createToolRegistry } from '@syncanix/sdk-node';

const registry = createToolRegistry();

registry.tool({
  name: 'refund-order',
  description: 'Refund a customer order. Requires an admin role.',
  handler: async ({ orderId, amountCents }, ctx) => {
    // ctx.userId is the verified end user from your identity provider.
    return payments.refund({ orderId, amountCents, actor: ctx.userId });
  },
});

4. ضمّن الأداة

أضِف وسم سكربت واحدًا إلى تطبيقك باستخدام مفتاحك القابل للنشر:

<script
  type="module"
  src="https://cdn.syncanix.com/widget.js"
  data-key="pk_live_..."
></script>

هذا كل شيء. تُحمَّل الأداة على نحوٍ مؤجَّل، وتعمل داخل Shadow DOM كي لا تتعارض أنماطك وأنماطنا أبدًا، وتلتقط هويتك التجارية تلقائيًا، وهي جاهزة للكتابة من اليمين إلى اليسار.

5. اربط عميل MCP (اختياري)

يحصل كل مساحة عمل أيضًا على خادم MCP خاص بها، فيتمكّن مستخدموك من بلوغ القدرات نفسها من Claude Desktop وCursor وChatGPT. ويُفوَّض تسجيل الدخول إلى مزوّد الهوية لديك.

6. رقِّ إلى الإنتاج

عندما ترضى عن سلوك المساعد في التطوير، رقِّه إلى الإنتاج من لوحة التحكم. تعمل أولًا بوابة تقييم تمنع الترقية إذا تراجعت الجودة، بحيث لا يتغيّر الإنتاج إلا نحو الأفضل.

ما لديك الآن

  • مساعد مضمَّن في تطبيقك يجيب عن الأسئلة وينفّذ إجراءاتك.
  • خادم MCP لكل مساحة عمل من أجل Claude Desktop وCursor وChatGPT.
  • سجلّ تدقيق لكل إجراء وكل ترقية وكل تغيير إداري.
  • كل شيء مستضاف في الاتحاد الأوروبي، مع تشفير بياناتك أثناء التخزين.

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