Uporaba HTTP API: BeamBench

Upravljajte Beam Bench iz katerega koli odjemalca HTTP. Iste operacije kot CLI, prijazno integracijam.

HTTP oziroma WebSocket API aplikacije Beam Bench je isti vmesnik, s katerim komunicira CLI. Če potrebujete Beam Bench v okolju, ki ni CLI, na primer v spletni aplikaciji, integracijskem strežniku ali mobilni aplikaciji, uporabite neposredno HTTP API.

Kaj potrebujete

Nameščen Beam Bench.
Lokalni API, omogočen v Edit → Settings → General. Privzeto je izklopljen.
Odjemalec HTTP (curl, knjižnica HTTP vašega jezika, Postman itd.).

Preverite, ali je API omogočen

Privzete vrednosti v trenutni gradnji so namerno zaklenjene:

Local API: izklopljeno.
API Port: 5900.
Allow network devices to connect: izklopljeno. Dokler ostane izklopljeno, strežnik sprejema povezave samo iz tega računalnika.

Odprite namizno aplikacijo, pojdite na Edit → Settings → General in vklopite Local API. Za skripte, ki se izvajajo v istem računalniku, pustite Allow network devices to connect izklopljeno. Nastavitve začnejo veljati takoj.

Pred povezovanjem v omrežje na skupnem omrežju Wi-Fi preberite stran HTTP API. API nima preverjanja pristnosti ter lahko premakne stroj in sproži laser.

Osnovni URL

http://localhost:5900/api/v1

(Če je možnost Allow network devices to connect vklopljena, lahko namesto localhost uporabite naslov LAN svojega stroja.)

Koraki

1. Preverite, ali API deluje

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

Vrne shemo zmogljivosti. (Če ste spremenili vrata, zamenjajte 5900 s konfiguriranimi vrati.)

2. Preglejte stanje

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

3. Odprite 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. Izrišite oblikovanje prek delujočega strežnika

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. Pridobite stanje kamere

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

6. Izrišite prekrivanje kamere prek čelnega dela aplikacije

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

Razpoložljive skupine končnih točk

Za celoten vmesnik glejte razdelek Referenca API (ko bo izpolnjen). Glavne skupine:

/agent, zmogljivosti, stanje, vodnik.
/camera, naprave, stanje, zajem, prekrivanje (prikaz, pretvorba, izris), umerjanje, poravnava.
/design, opis, izris, transakcije.
/projects, odpiranje, shranjevanje, zapiranje, plasti, predmeti, razveljavitev/ponovitev, uvoz.
/export, svg, dxf, pdf, eps, ai.

Varnost

Strežnik API nima preverjanja pristnosti. Predvideva, da je omrežje, v katerem deluje, zaupanja vredno.

Povezovanje samo z localhostom omeji izpostavljenost na lokalni računalnik.
Povezovanje v omrežje je ločena možnost in odpre API vsem v istem omrežju LAN. Omogočite ga samo v zaupanja vrednem omrežju.

Preverite delovanje

curl agent/capabilities vrne JSON.
Klic za izris ustvari zahtevano datoteko.

Uporaba HTTP API