Aller au contenu
Vérifié

Framework JavaScript

Le runtime, la CLI et les cinq méthodes de données d'application qu'ils partagent avec une clé API.

Le framework JS de Xuda n'est pas un module CPI que vous appelez : c'est un runtime de navigateur (le constructeur xuda(), les attributs xu-*, l'API de script xu) et une CLI locale (xuda-cli dev, sync, clean-readmes), qui s'exécutent tous deux en dehors de tout identifiant de compte. Ce qu'ils partagent avec le reste de cette section API tient en une chose : les données d'application. Les mêmes cinq méthodes dbs_* qu'une application du framework ou un programme JavaScript appelle à l'exécution via xu.dbs_read(...) sont directement accessibles avec une clé API de compte, donc votre propre backend peut lire et écrire les tables d'un projet sans passer par le runtime.

Lire et écrire une table

dbs_read, dbs_create, dbs_update et dbs_delete prennent tous l'_id de la table (jamais son nom d'affichage) comme table_id, dbs_restore prend le même table_id plus un tableau de ids de lignes pour rétablir une ligne supprimée de façon logicielle, et get_table_counts lit les nombres de lignes actives et archivées. dbs_read accepte une plage de lignes from/to facultative, un row_id pour une seule ligne, un sortModel et un objet query pour filtrer.

curl -s https://xuda.ai/cpi/dbs_read \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","app_id":"YOUR_APP_ID","table_id":"YOUR_TABLE_ID","from":0,"to":50}'
const res = await fetch('https://xuda.ai/cpi/dbs_read', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    app_id: 'YOUR_APP_ID',
    table_id: 'YOUR_TABLE_ID',
    from: 0,
    to: 50,
  }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/dbs_read',
    json={'api_key': 'YOUR_API_KEY', 'app_id': 'YOUR_APP_ID', 'table_id': 'YOUR_TABLE_ID', 'from': 0, 'to': 50},
)
Mêmes méthodes, deux appelants

Dans un projet, un programme javascript ou api les atteint via xu.dbs_create(...), xu.dbs_read(...) et ainsi de suite, avec app_id joint automatiquement. De l'extérieur, votre propre code appelle les mêmes méthodes via /cpi avec une clé API. Voir JavaScript pour le côté interne au projet.

Tout le reste de cette liste n'est pas une méthode d'API

get_app_system_api_methods, create_app_session, la famille create_*_api_key et get_plugin_setup apparaissent tous dans le code de runtime et de CLI du framework, mais chacun d'eux est soit private: true (réservé aux sessions ou au tableau de bord), soit pas du tout enregistré dans cpi_methods : une fonction interne au processus que le runtime appelle directement, et non une méthode distribuée. Les cinq méthodes dbs_* et get_table_counts sont les six seules avec Availability: API key.

Méthodes