Usare l'API HTTP

Controlla Beam Bench da qualsiasi client HTTP. Le stesse operazioni della CLI, adatte alle integrazioni.

L'API HTTP / WebSocket di Beam Bench è la stessa interfaccia con cui comunica la CLI. Se hai un caso d'uso che richiede Beam Bench in un ambiente non CLI, come un'app web, un server di integrazione o un'app mobile, usa direttamente l'API HTTP.

Cosa ti serve

Beam Bench installato.
L'API locale abilitata in Modifica → Impostazioni → Generale. Per impostazione predefinita è disattivata.
Un client HTTP (curl, la libreria HTTP del tuo linguaggio, Postman e così via).

Verifica che l'API sia abilitata

Le impostazioni predefinite della build corrente sono deliberatamente bloccate:

API locale: disattivata.
Porta API: 5900.
Consenti ai dispositivi di rete di connettersi: disattivata. Finché rimane disattivata, il server accetta connessioni solo da questo computer.

Apri l'app desktop, vai a Modifica → Impostazioni → Generale e attiva API locale. Lascia disattivata Consenti ai dispositivi di rete di connettersi per gli script eseguiti sullo stesso computer. Le impostazioni hanno effetto immediato.

Leggi la pagina dell'API HTTP prima di collegare l'API alla rete su una Wi-Fi condivisa. L'API non dispone di autenticazione e può spostare la macchina e accendere il laser.

URL di base

http://localhost:5900/api/v1

(O l'indirizzo IP LAN della macchina al posto di localhost, quando Consenti ai dispositivi di rete di connettersi è attivata.)

Passaggi

1. Verifica che l'API sia attiva

curl -s http://localhost:5900/api/v1/agent/capabilities | jq .

Restituisce lo schema delle funzionalità. (Sostituisci 5900 con la porta configurata se l'hai modificata.)

2. Controlla lo stato

curl -s http://localhost:5900/api/v1/agent/state | jq .

3. Apri un progetto

curl -s -X POST http://localhost:5900/api/v1/projects/open \
  -H 'Content-Type: application/json' \
  -d '{"path":"/abs/path/to/file.lzrproj"}'

4. Esegui il rendering del design tramite il server in esecuzione

curl -s -X POST http://localhost:5900/api/v1/design/render \
  -H 'Content-Type: application/json' \
  -d '{"format":"png","pixels_per_mm":4,"output_path":"/tmp/out.png"}'

5. Ottieni lo stato della fotocamera

curl -s http://localhost:5900/api/v1/camera/state | jq .

6. Esegui il rendering della sovrapposizione della fotocamera tramite il frontend dell'app

curl -s -X POST http://localhost:5900/api/v1/camera/overlay/render \
  -H 'Content-Type: application/json' \
  -d '{"output_path":"/tmp/overlay.png","view":"fit","keep":true}'

Gruppi di endpoint disponibili

Consulta la sezione Riferimento API, quando sarà compilata, per l'intera interfaccia. Gruppi principali:

/agent, funzionalità, stato, guida.
/camera, dispositivi, stato, acquisizione, sovrapposizione (visualizzazione, trasformazione, rendering), calibrazione, allineamento.
/design, descrizione, rendering, transazioni.
/projects, apertura, salvataggio, chiusura, livelli, oggetti, annulla/ripeti, importazione.
/export, svg, dxf, pdf, eps, ai.

Sicurezza

Il server API non dispone di autenticazione. Presuppone che la rete su cui si trova sia attendibile.

Il collegamento solo a localhost limita l'esposizione al computer locale.
Il collegamento alla rete è un'opzione separata e apre l'API a chiunque si trovi sulla stessa LAN. Abilitalo solo su una rete attendibile.

Verifica che abbia funzionato

curl agent/capabilities restituisce JSON.
Una chiamata di rendering produce il file richiesto.