HTTP API:n käyttäminen

Ohjaa Beam Benchiä mistä tahansa HTTP-asiakkaasta. Samat toiminnot kuin CLI:ssä, integraatioita varten.

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

Mitä tarvitset

Beam Benchin asennettuna.
Local API:n käyttöön kohdassa Edit → Settings → General. Se on oletuksena poissa käytöstä.
HTTP-asiakkaan, kuten curl-komennon, käyttämäsi kielen HTTP-kirjaston tai Postmanin.

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

Nykyisen koontiversion oletukset on tarkoituksella lukittu:

Local API: poissa käytöstä.
API Port: 5900.
Allow network devices to connect: poissa käytöstä. Kun se on poissa 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 poissa käytöstä samalla tietokoneella suoritettavia skriptejä varten. Asetukset tulevat voimaan heti.

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

Perus-URL-osoite

http://localhost:5900/api/v1

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

Vaiheet

1. Varmista, että API on käynnissä

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

Palauttaa ominaisuuksien skeeman. (Korvaa 5900 määritetyllä portillasi, jos olet muuttanut sitä.)

2. Tarkasta tila

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. Hahmonna suunnittelu käynnissä olevan palvelimen kautta

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. Hahmonna kamerapeite sovelluksen käyttöliittymän kautta

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, saadaksesi koko rajapinnan. Tärkeimmät ryhmät:

/agent, ominaisuudet, tila, opas.
/camera, laitteet, tila, kaappaus, peite (näyttö, muunnos, hahmonnus), kalibrointi, kohdistus.
/design, kuvaus, hahmonnus, tapahtumat.
/projects, avaa, tallenna, sulje, tasot, objektit, kumoa ja tee uudelleen, 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 sallittava toiminto, joka avaa API:n kaikille samassa lähiverkossa oleville. Ota se käyttöön vain luotetussa verkossa.

Varmista toiminta

curl agent/capabilities palauttaa JSON-tietoja.
Hahmonnuskutsu tuottaa pyydetyn tiedoston.