התחלה מהירה
מה-API הקיים שלכם ועד עוזר פעיל באפליקציה שלכם — בכ-90 דקות.
מדריך זה מוביל אתכם מאפליקציה קיימת לעוזר Syncanix פעיל: גלו את ה-API שלכם, בדקו מה העוזר יכול לעשות, חברו את הצד-השרת, הטמיעו את הרכיב וקדמו לייצור. רוב הצוותים משלימים זאת בכ-90 דקות.
לפני שמתחילים
- Node.js גרסה 20 ואילך.
- API מסוג HTTP קיים עם נקודת קצה מאומתת אחת לפחות.
- ספק זהויות עבור המשתמשים שלכם — Auth0, Clerk, Cognito, WorkOS או OIDC משלכם.
- מפתח של Anthropic, OpenAI או AWS Bedrock-EU — או השתמשו במפתח מנוהל (בחלק מהתוכניות חלה תוספת קטנה).
1. גלו את ה-API שלכם
הריצו את ה-CLI בפרויקט שלכם. הוא מזהה את ה-framework שלכם, קורא את הנתיבים, כותב קטלוג יכולות ומעלה אותו. הגילוי סטטי כברירת מחדל — הוא קורא את הקוד שלכם, אינו מריץ אותו, ושום נתוני ייצור אינם עוזבים את המחשב שלכם.
npx syncanix initהעשרת ה-AI האופציונלית (כותרות ותיאורים ברורים יותר) פועלת רק לאחר שתעניקו הסכמה מפורשת לאי-שמירת נתונים בהנחיה. אפשר גם לדלג עליה ולהעשיר מאוחר יותר.
2. בדקו את הקטלוג
פתחו את לוח הבקרה כדי לראות מה התגלה. כאן אתם מחליטים מה העוזר רשאי לעשות, ובאיזו זהירות:
- סמנו נקודות קצה פנימיות כך שיישארו מחוץ להישג ידו של העוזר.
- הגדירו את תופעת הלוואי של כל פעולה — קריאה, כתיבה או הרסנית — מה שקובע כיצד היא מאושרת.
- דרשו אימות מוגבר בפעולות רגישות, כך שהמשתמש יאשר מחדש את זהותו לפני שהן רצות.
3. חברו את הצד-השרת שלכם
הוסיפו את ה-Node SDK לשירות שבבעלותו ה-API שלכם. הוא מאתר את המפתח שלכם ועולה תוך אלפיות שנייה ספורות:
npm install @syncanix/sdk-nodeimport { 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 (אופציונלי)
בתוכניות Growth ומעלה, כל סביבת עבודה מקבלת גם שרת MCP משלה, כך שהמשתמשים שלכם מגיעים לאותן יכ ולות מ-Claude Desktop, מ-Cursor ומ-ChatGPT. ההתחברות מואצלת לספק הזהויות שלכם.
6. קדמו לייצור
כשאתם מרוצים מהתנהגות העוזר בפיתוח, קדמו אותו לייצור מתוך לוח הבקרה. תחילה רצה בדיקת הערכה שחוסמת את הקידום אם האיכות נסוגה, כך שהייצור משתנה רק לטובה.
מה יש לכם עכשיו
- עוזר מוטמע באפליקציה שלכם שעונה על שאלות ומבצע את הפעולות שלכם.
- שרת MCP לכל סביבת עבודה עבור Claude Desktop, Cursor ו-ChatGPT (Growth ומעלה).
- יומן ביקורת של כל פעולה, כל קידום וכל שינוי ניהולי.
- הכול מתארח באיחוד האירופי, כשהנתונים שלכם מוצפנים במנוחה.