Använda HTTP API:t

Styr Beam Bench från valfri HTTP-klient. Samma funktioner som CLI:t, anpassat för integrationer.

Beam Bench HTTP- och WebSocket-API är samma gränssnitt som CLI:t använder. Om du har ett användningsfall som kräver Beam Bench i en miljö utan CLI, till exempel en webbapp, integrationsserver eller mobilapp, använder du HTTP API:t direkt.

Det här behöver du

Beam Bench installerat.
Lokalt API aktiverat i Redigera → Inställningar → Allmänt. Det är avstängt som standard.
En HTTP-klient (curl, ditt språks HTTP-bibliotek, Postman och så vidare).

Kontrollera att API:t är aktiverat

Standardvärdena i den aktuella versionen är avsiktligt låsta:

Lokalt API: av.
API-port: 5900.
Tillåt nätverksenheter att ansluta: av. Så länge det är avstängt 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 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 maskinens 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 funktionsschemat. (Byt ut 5900 mot din konfigurerade port om du ändrade den.)

2. Inspektera 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 via den körande servern

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ånd

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

6. Rendera kameraöverlägget via appens frontend

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 slutpunktsgrupper

Se avsnittet API-referens, när det är ifyllt, för hela gränssnittet. Viktiga grupper:

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

Säkerhet

API-servern har ingen autentisering. Den förutsätter att nätverket den finns på ä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 det endast i ett betrott nätverk.

Kontrollera att det fungerade

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