BeamBench: HTTP API'yi kullanma

Beam Bench'i herhangi bir HTTP istemcisinden yönetin. CLI ile aynı işlemler, entegrasyona uygun.

Beam Bench'in HTTP / WebSocket API'si, CLI'nin konuştuğu arayüzün aynısıdır. Beam Bench'i CLI olmayan bir ortamda (web uygulaması, entegrasyon sunucusu, mobil uygulama) gerektiren bir kullanım durumunuz varsa HTTP API'yi doğrudan kullanın.

Gerekenler

Beam Bench kurulu olmalıdır.
Düzenle → Ayarlar → Genel içinden Yerel API etkinleştirilmelidir. Varsayılan olarak kapalı gelir.
Bir HTTP istemcisi (curl, kullandığınız dilin HTTP kitaplığı, Postman vb.).

API'nin etkin olduğunu doğrulama

Geçerli derlemedeki varsayılanlar özellikle kısıtlanmıştır:

Yerel API: kapalı.
API Bağlantı Noktası: 5900.
Ağ cihazlarının bağlanmasına izin ver: kapalı. Kapalı kaldığı sürece sunucu yalnızca bu bilgisayardan gelen bağlantıları kabul eder.

Masaüstü uygulamasını açın, Düzenle → Ayarlar → Genel bölümüne gidin ve Yerel API seçeneğini açın. Aynı bilgisayarda çalışan komut dosyaları için Ağ cihazlarının bağlanmasına izin ver seçeneğini kapalı tutun. Ayarlar hemen etkinleşir.

Paylaşılan bir Wi-Fi ağı üzerinde ağa bağlamadan önce HTTP API sayfasını okuyun. API'de kimlik doğrulama yoktur ve makineyi hareket ettirip lazeri ateşleyebilir.

Temel URL

http://localhost:5900/api/v1

(Ağ cihazlarının bağlanmasına izin ver açık olduğunda localhost yerine makinenizin LAN IP'sini kullanabilirsiniz.)

Adımlar

1. API'nin çalıştığını doğrulayın

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

Yetenek şemasını döndürür. (Değiştirdiyseniz 5900 yerine yapılandırılmış bağlantı noktanızı yazın.)

2. Durumu inceleyin

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

3. Proje açın

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

4. Tasarımı çalışan sunucu üzerinden oluşturun

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 durumunu alın

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

6. Kamera kaplamasını uygulamanın ön yüzü üzerinden oluşturun

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

Kullanılabilir uç nokta grupları

Tam arayüz için API başvurusu bölümüne (doldurulduğunda) bakın. Ana gruplar:

/agent, yetenekler, durum, kılavuz.
/camera, cihazlar, durum, yakalama, kaplama (görüntüleme, dönüşüm, oluşturma), kalibrasyon, hizalama.
/design, açıklama, oluşturma, işlemler.
/projects, açma, kaydetme, kapatma, katmanlar, nesneler, geri alma/yineleme, içe aktarma.
/export, svg, dxf, pdf, eps, ai.

Güvenlik

API sunucusunda kimlik doğrulama yoktur. Üzerinde bulunduğu ağa güvenildiğini varsayar.

Yalnızca localhost'a bağlanmak, maruz kalmayı yerel makineyle sınırlar.
Ağa bağlanma ayrı bir isteğe bağlı ayardır ve API'yi aynı LAN üzerindeki herkese açar. Yalnızca güvenilir bir ağda etkinleştirin.

Çalıştığını doğrulayın

curl agent/capabilities JSON döndürür.
Oluşturma çağrısı istenen dosyayı üretir.

HTTP API'yi kullanma