BeamBench: Korzystanie z API HTTP

Steruj Beam Bench z dowolnego klienta HTTP. Te same operacje co w CLI, przyjazne integracjom.

API HTTP / WebSocket Beam Bench to ten sam interfejs, z którym komunikuje się CLI. Jeśli masz przypadek użycia wymagający Beam Bench w środowisku innym niż CLI, takim jak aplikacja internetowa, serwer integracyjny lub aplikacja mobilna, użyj bezpośrednio API HTTP.

Czego potrzebujesz

Zainstalowanego Beam Bench.
Włączonego lokalnego API w Edycja → Ustawienia → Ogólne. Domyślnie jest wyłączone.
Klienta HTTP (curl, biblioteka HTTP używanego języka, Postman itd.).

Sprawdź, czy API jest włączone

Wartości domyślne bieżącej kompilacji są celowo zablokowane:

Lokalne API: wyłączone.
Port API: 5900.
Zezwalaj urządzeniom sieciowym na łączenie: wyłączone. Dopóki pozostaje wyłączone, serwer akceptuje połączenia tylko z tego komputera.

Otwórz aplikację desktopową, przejdź do Edycja → Ustawienia → Ogólne i włącz Lokalne API. Pozostaw opcję Zezwalaj urządzeniom sieciowym na łączenie wyłączoną dla skryptów uruchamianych na tym samym komputerze. Ustawienia zaczynają obowiązywać natychmiast.

Przeczytaj stronę API HTTP, zanim udostępnisz API w sieci współdzielonej Wi-Fi. API nie ma uwierzytelniania i może poruszać maszyną oraz uruchamiać laser.

Bazowy adres URL

http://localhost:5900/api/v1

(Lub adres IP LAN maszyny zamiast localhost, gdy opcja Zezwalaj urządzeniom sieciowym na łączenie jest włączona.)

Kroki

1. Sprawdź, czy API działa

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

Zwraca schemat możliwości. (Zastąp 5900 skonfigurowanym portem, jeśli został zmieniony.)

2. Sprawdź stan

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

3. Otwórz 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. Wyrenderuj projekt przez uruchomiony serwer

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. Pobierz stan kamery

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

6. Wyrenderuj nakładkę kamery przez frontend aplikacji

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

Dostępne grupy punktów końcowych

Pełny interfejs znajdziesz w sekcji Dokumentacja API, gdy zostanie uzupełniona. Główne grupy:

/agent, możliwości, stan, przewodnik.
/camera, urządzenia, stan, przechwytywanie, nakładka (wyświetlanie, przekształcenie, renderowanie), kalibracja, wyrównanie.
/design, opis, renderowanie, transakcje.
/projects, otwieranie, zapisywanie, zamykanie, warstwy, obiekty, cofanie/ponawianie, importowanie.
/export, svg, dxf, pdf, eps, ai.

Bezpieczeństwo

Serwer API nie ma uwierzytelniania. Zakłada, że sieć, w której działa, jest zaufana.

Powiązanie wyłącznie z localhost ogranicza dostęp do komputera lokalnego.
Powiązanie z siecią jest osobną opcją i udostępnia API każdemu w tej samej sieci LAN. Włączaj je tylko w zaufanej sieci.

Sprawdź, czy zadziałało

curl agent/capabilities zwraca JSON.
Wywołanie renderowania tworzy żądany plik.

Korzystanie z API HTTP