התחלה מהירה

מדריך זה מוביל אתכם מאפליקציה קיימת לעוזר Syncanix פעיל: גלו את ה-API שלכם, בדקו מה העוזר יכול לעשות, חברו את הצד-השרת, הטמיעו את הרכיב וקדמו לייצור. רוב הצוותים משלימים זאת בכ-90 דקות.

לפני שמתחילים

• סביבת עבודה ב-Syncanix — הירשמו בכתובת app.syncanix.com.
• Node.js גרסה 20 ואילך.
• API מסוג HTTP קיים עם נקודת קצה מאומתת אחת לפחות.
• ספק זהויות עבור המשתמשים שלכם — Auth0, Clerk, Cognito, WorkOS או OIDC משלכם.
• מפתח של Anthropic, OpenAI או AWS Bedrock-EU — או השתמשו בגישה מנוהלת למודל, הכלולה בתוכנית שלכם.

הגדירו את סביבת העבודה והמפתחות שלכם

ה-CLI לגילוי מעלה אל סביבת עבודה של Syncanix, והרכיב מאומת באמצעות מפתח לפרסום — לכן צרו את סביבת העבודה והעתיקו את שני המפתחות לפני שאתם מריצים משהו.

1. 1
   צרו את סביבת העבודה שלכםהירשמו בכתובת app.syncanix.com. לוח הבקרה הוא המקום שבו נמצאים הקטלוג, מפתחות ה-API ותצורת הרכיב שלכם.
2. 2
   שמרו את מפתח ה-CLI שלכםהריצו npx syncanix login והדביקו את המפתח הסודי (gak_…) המוצג תחת הגדרות ← מפתחות API. ה-CLI שומר אותו ב-~/.syncanix/credentials כדי ש-init יוכל להעלות את הקטלוג שלכם.
3. 3
   העתיקו את המפתח לפרסום שלכםמתוך הגדרות ← מפתחות API בלוח הבקרה, העתיקו את המפתח לפרסום שלכם (pk_live_…). קטע ההטמעה של הרכיב משתמש בו בתור ה-data-key שלו — הוא בטוח להטמעה בדפדפן.

npx syncanix login

1. גלו את ה-API שלכם

הריצו את ה-CLI בפרויקט שלכם. הוא מזהה את ה-framework שלכם, קורא את הנתיבים, כותב קטלוג יכולות ומעלה אותו. הגילוי סטטי כברירת מחדל — הוא קורא את הקוד שלכם, אינו מריץ אותו, ושום נתוני ייצור אינם עוזבים את המחשב שלכם.

npx syncanix init

העשרת ה-AI האופציונלית (כותרות ותיאורים ברורים יותר) פועלת רק לאחר שתעניקו הסכמה מפורשת לאי-שמירת נתונים בהנחיה. אפשר גם לדלג עליה ולהעשיר מאוחר יותר.

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.
• יומן ביקורת של כל פעולה, כל קידום וכל שינוי ניהולי.
• הכול מתארח באיחוד האירופי, כשהנתונים שלכם מוצפנים במנוחה.

השלבים הבאים