Vai al contenuto
Verificata

API

Un endpoint richiamabile del progetto, interno tramite call_project_api o esterno tramite l'endpoint api/mcp.

Un programma API è un livello di orchestrazione con un solo output: può associare un'origine dati, coordinare chiamate get_data, set_data e batch nei propri eventi e restituire una sola risposta, modellata da un template e non da associazioni di campi. Lo si chiama dall'interno del progetto con l'azione di workflow call_project_api, oppure lo si raggiunge dall'esterno tramite l'endpoint api/mcp del progetto.

Proprietà

progDataSource e progFields

Stessa forma di Origine dati, usata quando l'API legge o scrive una tabella per costruire la propria risposta. progFields dichiara i campi disponibili per il template della risposta, table per le colonne reali, virtual per quelle calcolate.

scriptData: il template della risposta

Il payload è un template di oggetto sotto forma di stringa in scriptData.value; le associazioni @field vengono risolte al momento della chiamata, con la stessa sintassi di espressioni usata ovunque nella piattaforma:

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

Chiamare un programma API

Internamente, call_project_api lo esegue esattamente come get_data o set_data eseguono i loro tipi di programma: name.prog indica l'id dell'API, name.parameters fornisce i suoi input.

Esempio pratico

Dichiara l'interfaccia

progParams per ogni valore di input (dir: "in") e di output (dir: "out").

Associa i dati se la risposta ne ha bisogno

Un progDataSource facoltativo, più progFields per le colonne che alimentano il template.

Scrivi il template della risposta

scriptData.value, un oggetto sotto forma di stringa con segnaposto @field, e imposta apiOutput sul formato che i chiamanti devono ricevere.

Crea un nodo API sotto Programmi, imposta apiOutput nella sua scheda Proprietà, associa facoltativamente un'Origine dati, poi scrivi la forma della risposta nell'editor Risposta.

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>

Il blocco <response> di .xu è scriptData.value, scritto come semplice espressione di oggetto invece che come stringa 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}" }
}