Saltar al contenido
Verificada

API

Un endpoint invocable del proyecto, interno mediante call_project_api o externo mediante el endpoint api/mcp.

Un programa API es una capa de orquestación con una sola salida: puede vincular una fuente de datos, coordinar llamadas get_data, set_data y batch dentro de sus propios eventos y devolver una única respuesta, con la forma de una plantilla y no de vinculaciones de campos. Llámalo desde dentro del proyecto con la acción de flujo de trabajo call_project_api, o llega a él desde fuera mediante el endpoint api/mcp del proyecto.

Propiedades

progDataSource y progFields

La misma forma que Fuente de datos, usada cuando la API lee o escribe una tabla como parte de la construcción de su respuesta. progFields declara los campos disponibles para la plantilla de respuesta, table para columnas reales, virtual para las calculadas.

scriptData: la plantilla de respuesta

La carga útil es una plantilla de objeto convertida en cadena en scriptData.value; las vinculaciones @field se resuelven en el momento de la llamada, con la misma sintaxis de expresiones que en el resto de la plataforma:

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

Llamar a un programa API

Internamente, call_project_api lo ejecuta exactamente igual que get_data o set_data ejecutan sus tipos de programa, name.prog nombra el id de la API, name.parameters aporta sus entradas.

Ejemplo práctico

Declara la interfaz

progParams para cada valor de entrada (dir: "in") y de salida (dir: "out").

Vincula datos si la respuesta los necesita

Un progDataSource opcional, más progFields para las columnas que alimentan la plantilla.

Escribe la plantilla de respuesta

scriptData.value, un objeto convertido en cadena con marcadores @field, y establece apiOutput en el formato que deben recibir quienes llamen.

Crea un nodo API en Programas, establece apiOutput en su pestaña Propiedades, vincula opcionalmente una Fuente de datos y escribe la forma de la respuesta en el editor Respuesta.

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>

El bloque <response> de .xu es scriptData.value, escrito como una expresión de objeto normal en lugar de una cadena 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}" }
}