Používání HTTP API

Ovládejte Beam Bench z libovolného HTTP klienta. Stejné operace jako v CLI, vhodné pro integraci.

HTTP / WebSocket API aplikace Beam Bench je stejné rozhraní, se kterým komunikuje CLI. Pokud potřebujete používat Beam Bench v prostředí bez CLI (webová aplikace, integrační server, mobilní aplikace), použijte přímo HTTP API.

Co potřebujete

Nainstalovaný Beam Bench.
Povolené Místní API v Upravit → Nastavení → Obecné. Ve výchozím nastavení je vypnuté.
HTTP klienta (curl, HTTP knihovnu vašeho jazyka, Postman atd.).

Ověření, že je API povolené

Výchozí nastavení v aktuálním sestavení je záměrně zabezpečené:

Místní API: vypnuto.
Port API: 5900.
Povolit zařízení v síti: vypnuto. Dokud zůstane vypnuté, server přijímá připojení pouze z tohoto počítače.

Otevřete desktopovou aplikaci, přejděte do Upravit → Nastavení → Obecné a zapněte Místní API. Pro skripty spuštěné na stejném počítači ponechte Povolit zařízení v síti vypnuté. Nastavení se projeví okamžitě.

Než API zpřístupníte v síti sdílené Wi-Fi, přečtěte si stránku HTTP API. API nemá žádné ověřování a může pohybovat strojem i spustit laser.

Základní URL

http://localhost:5900/api/v1

(Nebo místo localhost použijte LAN IP adresu počítače, pokud je zapnuté Povolit zařízení v síti.)

Postup

1. Ověřte, že API běží

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

Vrátí schéma schopností. (Pokud jste port změnili, nahraďte 5900 nakonfigurovaným portem.)

2. Zkontrolujte stav

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

3. Otevřete 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. Vykreslete návrh (bez grafického rozhraní)

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. Získejte stav kamery

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

6. Vykreslete překryv kamery (vyžaduje aplikaci)

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

Dostupné skupiny koncových bodů

Úplný přehled najdete v části referenční dokumentace API (až bude doplněna). Hlavní skupiny:

/agent, možnosti, stav a průvodce.
/camera, zařízení, stav, snímání, překrytí (zobrazení, transformace, vykreslení), kalibrace a zarovnání.
/design, popis, vykreslení a transakce.
/projects, otevírání, ukládání, zavírání, vrstvy, objekty, zpět/opakovat a import.
/export, svg, dxf, pdf, eps, ai.

Zabezpečení

Server API nemá žádné ověřování. Předpokládá, že síť, ve které se nachází, je důvěryhodná.

Vazba pouze na localhost omezuje vystavení na místní počítač.
Síťová vazba je samostatná volitelná funkce a zpřístupní API komukoli ve stejné LAN. Zapínejte ji pouze v důvěryhodné síti.

Ověření funkčnosti

curl agent/capabilities vrátí JSON.
Volání render vytvoří požadovaný soubor.