BeamBench: Bruke HTTP API-et

Styr Beam Bench fra en hvilken som helst HTTP-klient. De samme operasjonene som i CLI-en, tilpasset integrasjoner.

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

Det du trenger

Beam Bench installert.
Det lokale API-et aktivert i Edit → Settings → General. 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

Standardverdiene i den gjeldende versjonen er med hensikt låst:

Local API: av.
API Port: 5900.
Allow network devices to connect: av. Så lenge den er av, godtar serveren bare tilkoblinger fra denne datamaskinen.

Åpne skrivebordsappen, gå til Edit → Settings → General, og slå på Local API. La Allow network devices to connect 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 aktivere laseren.

Basis-URL

http://localhost:5900/api/v1

(Eller maskinens LAN-IP i stedet for localhost når Allow network devices to connect er på.)

Fremgangsmåte

1. Kontroller at API-et er tilgjengelig

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

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

2. Kontroller 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 gjennom serveren som kjører

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 kameratilstand

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

6. Gjengi kameraoverlegget gjennom appens frontend

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 fylt ut, for hele grensesnittet. Hovedgrupper:

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

Sikkerhet

API-serveren har ingen autentisering. Den antar at nettverket den er på, er klarert.

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

Kontroller at det fungerte

curl agent/capabilities returnerer JSON.
Et gjengivelseskall oppretter den forespurte filen.

Bruke HTTP API-et