Zum Inhalt springen
Geprüft

API

Ein aufrufbarer Endpunkt des Projekts, intern über call_project_api oder extern über den Endpunkt api/mcp.

Ein API-Programm ist eine Orchestrierungsschicht mit einer Ausgabe: Es kann eine Datenquelle binden, Aufrufe von get_data, set_data und batch in seinen eigenen Ereignissen koordinieren und eine Antwort zurückgeben, die von einer Vorlage statt von Feldbindungen geformt wird. Rufe es innerhalb des Projekts mit der Workflow-Aktion call_project_api auf oder erreiche es von außen über den Endpunkt api/mcp des Projekts.

Eigenschaften

progDataSource und progFields

Dieselbe Form wie bei Datenquelle, genutzt, wenn die API beim Aufbau ihrer Antwort eine Tabelle liest oder schreibt. progFields deklariert die Felder, die für die Antwortvorlage verfügbar sind, table für echte Spalten, virtual für berechnete.

scriptData: die Antwortvorlage

Die Nutzlast ist eine als String vorliegende Objektvorlage in scriptData.value; @field-Bindungen werden zum Aufrufzeitpunkt aufgelöst, mit derselben Ausdruckssyntax wie überall sonst in der Plattform:

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

Ein API-Programm aufrufen

Intern führt call_project_api es genau so aus, wie get_data oder set_data ihre Programmtypen ausführen: name.prog nennt die ID der API, name.parameters liefert ihre Eingaben.

Praxisbeispiel

Die Schnittstelle deklarieren

progParams für jeden Eingabewert (dir: "in") und Ausgabewert (dir: "out").

Daten binden, falls die Antwort sie braucht

Eine optionale progDataSource, plus progFields für die Spalten, die in die Vorlage einfließen.

Die Antwortvorlage schreiben

scriptData.value, ein als String vorliegendes Objekt mit @field-Platzhaltern, und setze apiOutput auf das Format, das Aufrufer zurückbekommen sollen.

Lege unter Programme einen API-Knoten an, setze apiOutput auf seinem Tab Eigenschaften, binde optional eine Datenquelle und schreibe dann die Antwortform im Editor Antwort.

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>

Der .xu-Block <response> ist scriptData.value, geschrieben als einfacher Objektausdruck statt als JSON-String.

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}" }
}