HTTP API:n käyttö

Ohjaa Beam Benchiä millä tahansa HTTP-asiakasohjelmalla. Samat toiminnot kuin CLI:ssä, helppo integroida.

Beam Benchin HTTP- ja WebSocket-rajapinta on sama rajapinta, jota CLI käyttää. Jos tarvitset Beam Benchiä muussa kuin CLI-ympäristössä, kuten verkkosovelluksessa, integraatiopalvelimessa tai mobiilisovelluksessa, käytä suoraan HTTP API:a.

Mitä tarvitset

Beam Benchin asennettuna.
Paikallisen API:n käytössä kohdassa Edit → Settings → General. Se on oletusarvoisesti pois käytöstä.
HTTP-asiakasohjelman (curl, käyttämäsi ohjelmointikielen HTTP-kirjaston, Postmanin tai vastaavan).

Varmista, että API on käytössä

Nykyisen koontiversion oletusasetukset on tarkoituksella lukittu:

Local API: pois käytöstä.
API-portti: 5900.
Salli verkkolaitteiden muodostaa yhteys: pois käytöstä. Kun asetus on pois käytöstä, palvelin hyväksyy yhteyksiä vain tältä tietokoneelta.

Avaa työpöytäsovellus, siirry kohtaan Edit → Settings → General ja ota Local API käyttöön. Jätä Allow network devices to connect pois käytöstä samalla tietokoneella suoritettavia komentosarjoja varten. Asetukset tulevat voimaan heti.

Lue HTTP API -sivu ennen verkkoon sitomista jaetussa Wi-Fi-verkossa. API:ssa ei ole todennusta, ja sen avulla voi liikuttaa konetta sekä laukaista laserin.

Perus-URL-osoite

http://localhost:5900/api/v1

(Tai käytä localhostin sijaan koneesi lähiverkon IP-osoitetta, kun Allow network devices to connect on käytössä.)

Vaiheet

1. Varmista, että API toimii

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

Palauttaa ominaisuusskeeman. (Korvaa 5900 määrittämälläsi portilla, jos olet vaihtanut porttia.)

2. Tarkastele tilaa

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

3. Avaa projekti

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

4. Renderöi suunnitelma ilman käyttöliittymää

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. Hae kameran tila

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

6. Renderöi kameran peitekuva, vaatii sovelluksen

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

Käytettävissä olevat pääteryhmät

Katso API-viite -osio, kun se on täytetty, nähdäksesi koko rajapinnan. Tärkeimmät ryhmät:

/agent, ominaisuudet, tila ja opas.
/camera, laitteet, tila, kaappaus, peittokuva (näyttö, muunnos, piirto), kalibrointi ja kohdistus.
/design, kuvaus, piirto ja tapahtumaketjut.
/projects, avaaminen, tallentaminen, sulkeminen, tasot, objektit, kumoaminen, uudelleenteko ja tuonti.
/export, svg, dxf, pdf, eps, ai.

Tietoturva

API-palvelimessa ei ole todennusta. Se olettaa käyttämänsä verkon olevan luotettu.

Vain localhostiin sitominen rajoittaa näkyvyyden paikalliseen tietokoneeseen.
Verkkoon sitominen on erikseen käyttöön otettava asetus, joka avaa API:n kaikille samassa lähiverkossa oleville. Ota se käyttöön vain luotetussa verkossa.

Varmista, että toiminto onnistui

curl agent/capabilities palauttaa JSON-tiedot.
Renderöintikutsu tuottaa pyydetyn tiedoston.