דילוג לתוכן
אומת

API

נקודת קצה של הפרויקט שניתנת לקריאה, פנימית דרך call_project_api או חיצונית דרך נקודת הקצה api/mcp.

תוכנית API היא שכבת תזמור עם פלט אחד: היא יכולה לקשור מקור נתונים, לתאם קריאות get_data, set_data ו-batch בתוך האירועים שלה, ולהחזיר תגובה אחת שמעוצבת לפי תבנית ולא לפי קישורי שדות. קוראים לה מתוך הפרויקט עם פעולת תהליך העבודה call_project_api, או מגיעים אליה מבחוץ דרך נקודת הקצה api/mcp של הפרויקט.

מאפיינים

progDataSource ו-progFields

אותה צורה כמו מקור נתונים, בשימוש כש-API קורא או כותב טבלה כחלק מבניית התגובה שלו. progFields מצהיר על השדות הזמינים לתבנית התגובה, table לעמודות אמיתיות, virtual למחושבות.

scriptData: תבנית התגובה

המטען הוא תבנית אובייקט שהומרה למחרוזת ב-scriptData.value; קישורי @field נפתרים בזמן הקריאה, באותו תחביר ביטויים כמו בכל מקום אחר בפלטפורמה:

json
{ "value": "{\n   CS_Id: @CS_Id,\n   CS_Class_Id: @CS_Class_Id,\n   CS_School_Id: @CS_School_Id\n}" }

קריאה לתוכנית API

פנימית, call_project_api מריצה אותה בדיוק כמו ש-get_data או set_data מריצות את סוגי התוכניות שלהן, name.prog מציין את המזהה של ה-API, name.parameters מספק את הקלטים שלו.

דוגמת עבודה

להצהיר על הממשק

progParams לכל ערך קלט (dir: "in") ופלט (dir: "out").

לקשור נתונים אם התגובה צריכה אותם

progDataSource אופציונלי, ועוד progFields לכל עמודה שמזינה את התבנית.

לכתוב את תבנית התגובה

scriptData.value, אובייקט שהומר למחרוזת עם מציינים @field, ומגדירים את apiOutput לפורמט שהקוראים אמורים לקבל בחזרה.

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

xml
<meta lang="json5">
{
  id: "student_classes_api",
  menuTitle: "Student Dashboard API",
  apiOutput: "json"
}
</meta>

<params lang="json5">
{
  in: { campus_in: "string", active_view_in: "string" }
}
</params>

<response>
({
  ok: true,
  campus: @campus_in,
  activeView: @active_view_in,
  summary: { students: 3, tasks: 3, profiles: 3 }
})
</response>

בלוק <response> ב-.xu הוא scriptData.value, שנכתב כביטוי אובייקט פשוט ולא כמחרוזת JSON.

json
{
  "properties": {
    "menuType": "api", "menuName": "Student Classes", "apiOutput": "json",
    "progParams": [{ "id": 1734434656288, "data": { "dir": "in", "parameter": "user_id_in", "type": "string" }, "props": {} }]
  },
  "progDataSource": {
    "dataSourceType": "table", "dataSourceFilterModelType": "index",
    "dataSourceTableId": "5b1_tbl_…", "dataSourceIndexId": "be2d06c8-…"
  },
  "progFields": [
    { "id": 1489199308774, "data": { "type": "table", "field_id": "CS_Id" }, "props": { "fieldType": "string" } }
  ],
  "scriptData": { "value": "{\n   CS_Id: @CS_Id\n}" }
}