A HTTP API használata: BeamBench

A Beam Bench vezérlése bármely HTTP-kliensből. Ugyanazok a műveletek, mint a CLI-ben, integrációbarát módon.

A Beam Bench HTTP / WebSocket API-ja ugyanazt a felületet biztosítja, amelyet a CLI használ. Ha olyan esetben van szükség a Beam Bench használatára, amely nem CLI-környezetet igényel (webalkalmazás, integrációs szerver, mobilalkalmazás), használja közvetlenül a HTTP API-t.

Amire szükség van

Telepített Beam Bench.
A Helyi API engedélyezve az Szerkesztés → Beállítások → Általános menüben. Alapértelmezés szerint ki van kapcsolva.
HTTP-kliens (curl, a választott programozási nyelv HTTP-könyvtára, Postman stb.).

Az API engedélyezésének ellenőrzése

Az aktuális verzió alapértelmezett beállításai szándékosan korlátozottak:

Helyi API: kikapcsolva.
API-port: 5900.
Hálózati eszközök engedélyezése: kikapcsolva. Amíg ki van kapcsolva, a szerver csak erről a számítógépről fogad kapcsolatokat.

Nyissa meg az asztali alkalmazást, lépjen az Szerkesztés → Beállítások → Általános menübe, majd kapcsolja be a Helyi API lehetőséget. Hagyja kikapcsolva az Hálózati eszközök engedélyezése beállítást, ha a szkriptek ugyanazon a számítógépen futnak. A beállítások azonnal érvénybe lépnek.

Olvassa el a HTTP API oldalt, mielőtt megosztott Wi-Fi-hálózaton a hálózati interfészhez kötné az API-t. Az API nem használ hitelesítést, és képes mozgatni a gépet, valamint elsütni a lézert.

Alap URL

http://localhost:5900/api/v1

(Vagy a localhost helyett a gép LAN IP-címe, ha az Hálózati eszközök engedélyezése be van kapcsolva.)

Lépések

1. Ellenőrizze, hogy az API működik-e

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

Visszaadja a képességek sémáját. (Ha módosította a portot, a 5900 helyett a beállított portot adja meg.)

2. Állapot lekérdezése

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

3. Projekt megnyitása

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

4. A terv renderelése (fej nélküli módban)

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. Kameraállapot lekérése

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

6. Kameraátfedés renderelése (alkalmazást igényel)

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

Elérhető végpontcsoportok

A teljes felületért tekintse meg az API-referencia szakaszt (amikor már feltöltötték). Főbb csoportok:

/agent: képességek, állapot, útmutató.
/camera: eszközök, állapot, képrögzítés, átfedés (megjelenítés, átalakítás, renderelés), kalibrálás, igazítás.
/design: leírás, renderelés, tranzakciók.
/projects: megnyitás, mentés, bezárás, rétegek, objektumok, visszavonás/újra, importálás.
/export, svg, dxf, pdf, eps, ai.

Biztonság

Az API-szerver nem használ hitelesítést. Feltételezi, hogy a hálózat, amelyen működik, megbízható.

A csak localhosthoz való kötés a helyi számítógépre korlátozza a kitettséget.
A hálózati kötés külön engedélyezhető, és az API-t megnyitja ugyanazon LAN minden felhasználója előtt. Csak megbízható hálózaton engedélyezze.

A működés ellenőrzése

A curl agent/capabilities JSON-t ad vissza.
A renderelési hívás létrehozza a kért fájlt.

A HTTP API használata