Saltar para o conteúdo
Verificado

JavaScript Framework

O runtime, a CLI e os cinco métodos de dados da aplicação que partilham com uma chave de API.

A Xuda JS Framework não é um módulo CPI que se chame, é um runtime de navegador (o construtor xuda(), os atributos xu-*, a API de scripts xu) e uma CLI local (xuda-cli dev, sync, clean-readmes), ambos a correr fora de qualquer credencial de conta. O que partilham com o resto desta secção da API é uma só coisa: os dados da aplicação. Os mesmos cinco métodos dbs_* que uma aplicação da framework ou um programa JavaScript chama em tempo de execução através de xu.dbs_read(...) são acessíveis diretamente com uma chave de API de conta, pelo que o seu próprio backend pode ler e escrever as tabelas de um projeto sem passar pelo runtime de todo.

Ler e escrever numa tabela

dbs_read, dbs_create, dbs_update e dbs_delete recebem todos o _id da tabela (nunca o seu nome de apresentação) como table_id, dbs_restore recebe o mesmo table_id mais um array de ids de linhas para repor uma linha eliminada de forma recuperável, e get_table_counts lê as contagens de linhas ativas e arquivadas. dbs_read aceita um intervalo de linhas from/to opcional, um row_id para uma única linha, um sortModel e um objeto query para filtrar.

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},
)
Os mesmos métodos, dois chamadores

Dentro de um projeto, um programa javascript ou api chega a estes através de xu.dbs_create(...), xu.dbs_read(...) e assim por diante, com o app_id anexado automaticamente. Do exterior, o seu próprio código chama os métodos idênticos por /cpi com uma chave de API. Consulte JavaScript para o lado dentro do projeto.

Tudo o resto nesta lista não é um método de API

get_app_system_api_methods, create_app_session, a família create_*_api_key e get_plugin_setup aparecem todos no código de runtime e da CLI da própria framework, mas cada um deles é private: true (apenas de sessão ou do painel) ou não está registado em cpi_methods, uma função em processo que o runtime chama diretamente, em vez de um método despachado. Os cinco métodos dbs_* e get_table_counts são os únicos seis com Availability: API key.

Métodos