BeamBench: Bruke HTTP-API-et

Styr Beam Bench fra en hvilken som helst HTTP-klient. Samme operasjoner som CLI-et, integrasjonsvennlig.

Beam Bench sitt HTTP- og WebSocket-API er det samme grensesnittet som CLI-et bruker. Hvis du har et bruksområde som trenger Beam Bench i et miljø uten CLI, for eksempel en nettapp, en integrasjonsserver eller en mobilapp, kan du bruke HTTP-API-et direkte.

Dette trenger du

Beam Bench installert.
Lokal-API-et aktivert i Rediger → Innstillinger → Generelt. Det er deaktivert som standard.
En HTTP-klient (curl, HTTP-biblioteket for språket ditt, Postman og så videre).

Kontroller at API-et er aktivert

Standardinnstillingene i den gjeldende versjonen er bevisst låst ned:

Lokal-API: av.
API-port: 5900.
Tillat nettverksenheter å koble til: av. Så lenge dette er av, godtar serveren bare tilkoblinger fra denne datamaskinen.

Åpne skrivebordsappen, gå til Rediger → Innstillinger → Generelt, og slå på Lokal-API. La Tillat nettverksenheter å koble til være av for skript som kjører på samme datamaskin. Innstillingene trer i kraft umiddelbart.

Les HTTP-API-siden før du binder til nettverket på et delt Wi-Fi. API-et har ingen autentisering og kan flytte maskinen og utløse laseren.

Basis-URL

http://localhost:5900/api/v1

(Eller maskinens LAN-IP i stedet for localhost når Tillat nettverksenheter å koble til er på.)

Fremgangsmåte

1. Kontroller at API-et kjører

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

Returnerer kapabilitetsskjemaet. (Bytt ut 5900 med den konfigurerte porten hvis du har endret den.)

2. Inspiser tilstanden

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

3. Åpne et prosjekt

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

4. Gjengi designet uten brukergrensesnitt

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. Hent kameratilstanden

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

6. Gjengi kameraoverlegget, krever appen

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

Tilgjengelige endepunktgrupper

Se delen API-referanse når den er utfylt, for hele grensesnittet. Viktige grupper:

/agent, kapabiliteter, tilstand, veiledning.
/camera, enheter, tilstand, opptak, overlegg (visning, transformasjon, gjengivelse), kalibrering, justering.
/design, beskrivelse, gjengivelse, transaksjoner.
/projects, åpne, lagre, lukke, lag, objekter, angre/gjør om, importere.
/export, svg, dxf, pdf, eps, ai.

Sikkerhet

API-serveren har ingen autentisering. Den forutsetter at nettverket den er koblet til, er klarert.

Binding bare til localhost begrenser eksponeringen til den lokale datamaskinen.
Nettverksbinding er et separat aktivt valg og åpner API-et for alle på samme LAN. Aktiver det bare på et klarert nettverk.

Kontroller at det fungerte

curl agent/capabilities returnerer JSON.
Et kall til gjengivelse oppretter den forespurte filen.

Bruke HTTP-API-et