Använda HTTP-API:t

Styr Beam Bench från valfri HTTP-klient. Samma funktioner som CLI:t, enkelt att integrera.

Beam Bench:s HTTP-/WebSocket-API är samma gränssnitt som CLI:t använder. Om du behöver använda Beam Bench i en miljö utan CLI (webbapp, integrationsserver, mobilapp) kan du använda HTTP-API:t direkt.

Det här behöver du

Beam Bench installerat.
Det lokala API:t aktiverat i Redigera → Inställningar → Allmänt. Det är avstängt som standard.
En HTTP-klient (curl, HTTP-biblioteket för ditt språk, Postman eller liknande).

Kontrollera att API:t är aktiverat

Standardinställningarna i den aktuella versionen är medvetet låsta:

Lokalt API: av.
API-port: 5900.
Tillåt nätverksenheter att ansluta: av. Så länge den är avstängd accepterar servern endast anslutningar från den här datorn.

Öppna skrivbordsappen, gå till Redigera → Inställningar → Allmänt och aktivera Lokalt API. Låt Tillåt nätverksenheter att ansluta vara avstängt för skript som körs på samma dator. Inställningarna börjar gälla omedelbart.

Läs HTTP-API-sidan innan du binder API:t till nätverket på ett delat Wi-Fi. API:t har ingen autentisering och kan flytta maskinen och aktivera lasern.

Bas-URL

http://localhost:5900/api/v1

(Eller datorns LAN-IP i stället för localhost när Tillåt nätverksenheter att ansluta är aktiverat.)

Steg

1. Kontrollera att API:t är igång

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

Returnerar kapabilitetsschemat. (Ersätt 5900 med den konfigurerade porten om du har ändrat den.)

2. Kontrollera tillståndet

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

3. Öppna ett projekt

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

4. Rendera designen (utan gränssnitt)

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. Hämta kameratillståndet

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

6. Rendera kameraöverlägget (appen krävs)

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}'

Tillgängliga endpoint-grupper

Se avsnittet API-referens (när det har fyllts i) för hela gränssnittet. Viktiga grupper:

/agent, kapabiliteter, tillstånd, guide.
/camera, enheter, tillstånd, bildtagning, överlägg (visning, transformering, rendering), kalibrering, justering.
/design, beskrivning, rendering, transaktioner.
/projects, öppna, spara, stäng, lager, objekt, ångra/gör om, importera.
/export, svg, dxf, pdf, eps, ai.

Säkerhet

API-servern har ingen autentisering. Den förutsätter att nätverket den finns i är betrott.

Bindning till endast localhost begränsar exponeringen till den lokala datorn.
Nätverksbindning är ett separat aktivt val och öppnar API:t för alla på samma LAN. Aktivera den endast i ett betrott nätverk.

Kontrollera att det fungerade

curl agent/capabilities returnerar JSON.
Ett renderingsanrop skapar den begärda filen.