דלג לתוכן הראשי
עיון בתיעוד

התחלה מהירה

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

המדריך הזה לוקח אתכם מאפליקציה קיימת לעוזר Syncanix פעיל, בסדר שבו זה קורה באמת: הוסיפו את הקטע, מפו את האתר שלכם, ואז פרסמו את המדריכים שהוא מנסח ממה שמצא. הבדיקה והעלייה לאוויר נמצאות משני צדי זה. שני שלבים אופציונליים ומסומנים ככאלה — סריקה עמוקה יותר של הקוד שלכם, וחיבור ישיר של השרת שלכם.

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

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

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

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

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

2. הטמיעו את הווידג׳ט

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

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

זה הכול. הרכיב נטען בעצלתיים, פועל בתוך Shadow DOM כך שהסגנונות שלכם ושלנו לעולם לא יתנגשו, מאמץ את המותג שלכם אוטומטית, ומוכן לכתיבה מימין לשמאל.

3. תנו לו לקרוא את המוצר שלכם

כשהווידג׳ט על הדף, הסוכן מבין מה המוצר שלכם יכול לעשות מתוך התבוננות בו. זה קורה בשתי דרכים, ואתם לא צריכים לבחור: הראשונה מכוונת ומהירה, השנייה רצה בשקט מאז והלאה.

  1. מפו את האתר שלכם, במעבר אחדהתחילו מיפוי מלוח הבקרה והקליקו בתוך המוצר שלכם, בדפדפן שלכם, מחוברים כעצמכם. הוא רושם כל מסך תוך כדי. שום דבר לא נשלח משום מקום מלבד הלשונית שאתם בה.
  2. ואז ברציפות, בזמן שהמשתמשים שלכם מתנועעיםברגע שהוא באוויר, הוא ממשיך לקרוא את המסכים שאנשים באמת מבקרים בהם, כך שדף שתעלו ביום שלישי ידוע ביום שלישי. אף אחד לא פותח כרטיס כדי ללמד אותו.

4. סקרו את מה שהוא מצא

פתחו את לוח הבקרה כדי לראות מה התגלה. כאן אתם מחליטים מה העוזר רשאי לעשות, ובאיזו זהירות:

  • סמנו נקודות קצה פנימיות כך שיישארו מחוץ להישג ידו של העוזר.
  • הגדירו את תופעת הלוואי של כל פעולה — קריאה, כתיבה או הרסנית — מה שקובע כיצד היא מאושרת.
  • דרשו אימות מוגבר בפעולות רגישות, כך שהמשתמש יאשר מחדש את זהותו לפני שהן רצות.

5. אופציונלי: קראו את הקוד שלכם לצורות המדויקות

קריאת מסך אומרת לסוכן מה אדם יכול לעשות שם. קריאת הקוד שלכם אומרת לו בדיוק מה התוכנה שלכם מקבלת — שמות הפרמטרים, הטיפוסים, מה נדרש — ומוצאת יכולות שאיש עוד לא ביקר בהן. זה המסלול העמוק יותר, לא הקשה יותר: אף קובץ קוד לא עוזב את המחשב שלכם. הריצו אותו מהמאגר שלכם:

npx syncanix init

6. אופציונלי: חברו את הבקאנד

כשאתם מוסיפים אותה, התקינו את ה-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 });
  },
});

7. חברו לקוח AI

כל סביבת עבודה מקבלת גם שרת MCP משלה, כך שהמשתמשים שלכם יכולים להגיע לאותן יכולות מ-Claude Desktop, מ-Cursor ומ-ChatGPT. ההתחברות מואצלת לספק הזהות שלכם.

8. עלו לאוויר

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

מה יש לכם עכשיו

  • עוזר מוטמע באפליקציה שלכם שעונה על שאלות ומבצע את הפעולות שלכם.
  • שרת MCP לכל סביבת עבודה עבור Claude Desktop, Cursor ו-ChatGPT.
  • יומן ביקורת של כל פעולה, כל קידום וכל שינוי ניהולי.
  • הכול מתארח באיחוד האירופי, כשהנתונים שלכם מוצפנים במנוחה.

השלבים הבאים