חיבור המערכת הראשונה שלכם, מקצה לקצה
המסלול המלא מ-API חשוף ועד תשובת עוזר עובדת: מופע מחבר, יכולת מוצהרת, והשער שבודק את שניהם לפני שמשהו עולה לאוויר.
לגרום לקו לענות ממערכת שהוא עוד לא מכיר הוא שני מעשים נפרדים: התחברות למערכת, והצהרה על מה שהעוזר מותר לו לבקש ממנה. ההפרדה הזאת מכוונת — מחבר מתאר איך להגיע למערכת, יכולת מתארת מה מותר לתושב לשאול, ואף אחד מהם לא צריך להכיר את הפרטים של השני.
1. רישום מופע מחבר
במסך מחברים, צרו מופע חדש. תזינו:
- מזהה (slug) — שם יציב בצורת כתובת URL שתפנו אליו בהמשך (
rlz-umbraco, ולא "אומברקו 2"). - הגדרה (definition) — איזה סוג מערכת זו (סוג המחבר שהמפעיל של הפלטפורמה שלכם הנגיש).
- כתובת בסיס (base URL) — כתובת מוחלטת
http(s)://; כתובת יחסית או בסכימת קובץ תידחה, כאן ושוב בשרת. - שם ערך בכספת (credential vault key) — השם של סוד שכבר שמור בכספת המפתחות שלכם, אף פעם לא הסוד עצמו. אין שום שדה בסטודיו שמקבל ערך אישור גישה גולמי.
מופע חדש נוצר במצב טיוטה ובמצב דמה (Mock), ובמצב הזה הוא לא יכול לקרוא לשום דבר. זה מובנה, לא פיצ'ר חסר — מעבר לאוויר הוא צעד נפרד, מכוון וניתן לביקורת במסך של המופע עצמו, כך ששום דבר שעדיין מחווטים לא יכול להגיע בטעות למערכת אמיתית.
2. הצהרת היכולת
במסך קטלוג, הצהירו על יכולת חדשה מול המחבר הזה. כאן נכנסות שלוש הפאות:
- סמנטיקה (מה שהמודל קורא): תקציר, מתי להשתמש, מתי לא להשתמש, וכל הבהרת דו-משמעות — זהה בכל שפה ובכל עירייה.
- חוזה (Contract): שדות הקלט שאליהם מתפרשת שאלת התושב, ושדות הפלט שהיכולת מבטיחה להחזיר — מתוארים כטבלה של שם / סוג / חובה / תיאור, לא כ-JSON גולמי, אם כי העורך הגולמי תמיד לחיצה אחת משם בשביל צורה שהטבלה לא יכולה להכיל.
- מדיניות (Policy): רמת ההזדהות הנדרשת (A0 עד A4), מחלקת רגישות המידע, זכאות אופציונלית, מטמון, ועבור יכולת כתיבה — אישור וחלון אידמפוטנטיות, שכפויים ולא אופציונליים.
- תצוגה (Rendering): איזה רמז תצוגה התשובה משתמשת בו (טקסט, רשימת כרטיסים, טבלה, פרטים או אישור) ואילו שדות מספריים, כך שהמספר תמיד נשאב מהנתונים שלכם ואף פעם לא מוקלד על ידי המודל.
עקבו אחרי הפאנל מימין תוך כדי הקלדה. זה לא סיכום ולידציה — זו הידור חי של הכלי הממשי שהעוזר יקבל, כולל התיאור. אם כתוב ששדה הוסר כפרמטר זהות, זו לא אזהרה להתעלם ממנה; זה אומר שהחוזה ביקש משהו (כמו מזהה תושב) שאסור לו לעולם להגיע מהקורא.
3. תנו לשער להחליט, לא לשיקול הדעת שלכם
כפתור השמירה מנוטרל כל עוד לטיוטה המהודרת יש אבחון ברמת שגיאה — לא מטעמי נימוס, אלא כי אותה בדיקה בדיוק רצה שוב, זהה, ברגע שתנסו בפועל להצהיר עליה. אין דרך לעקוף אותה על ידי שמירה בכל זאת.
ברגע שהיא ירוקה, שמרו את היכולת. היא זמינה לשימוש העוזר מאותו רגע, בכל ערוץ שהארגון שלכם הפעיל — כי יכולת לא מחווטת לערוץ אחד, היא מחווטת לפלטפורמה כולה.