Naar de inhoud springen
Geverifieerd

API

Een aanroepbaar eindpunt van het project, intern via call_project_api of extern via het eindpunt api/mcp.

Een API-programma is een orkestratielaag met één uitvoer: het kan een datasource binden, get_data-, set_data- en batch-aanroepen coördineren binnen zijn eigen gebeurtenissen, en één antwoord teruggeven, gevormd door een sjabloon in plaats van door veldbindingen. Roep het van binnen het project aan met de workflowactie call_project_api, of bereik het van buiten via het eindpunt api/mcp van het project.

Eigenschappen

progDataSource en progFields

Dezelfde vorm als Datasource, gebruikt als de API een tabel leest of schrijft om haar antwoord op te bouwen. progFields declareert de velden die beschikbaar zijn voor het antwoordsjabloon, table voor echte kolommen, virtual voor berekende.

scriptData: het antwoordsjabloon

De payload is een sjabloon van een object als tekst op scriptData.value; @field-bindingen worden bij de aanroep opgelost, met dezelfde expressiesyntaxis als overal elders op het platform:

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

Een API-programma aanroepen

Intern voert call_project_api het precies zo uit als get_data of set_data hun programmatypen uitvoeren: name.prog noemt de id van de API, name.parameters levert de invoer.

Uitgewerkt voorbeeld

Declareer de interface

progParams voor elke invoerwaarde (dir: "in") en uitvoerwaarde (dir: "out").

Bind gegevens als het antwoord ze nodig heeft

Een optionele progDataSource, plus progFields voor de kolommen die het sjabloon voeden.

Schrijf het antwoordsjabloon

scriptData.value, een object als tekst met @field-plaatshouders, en stel apiOutput in op het formaat dat aanroepers terug moeten krijgen.

Maak een API-knooppunt onder Programma's, stel apiOutput in op het tabblad Eigenschappen, bind eventueel een Datasource, en schrijf dan de vorm van het antwoord in de editor Antwoord.

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>

Het blok <response> in .xu is scriptData.value, geschreven als een gewone objectexpressie in plaats van een JSON-tekst.

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