Brug HTTP API'et

Styr Beam Bench fra enhver HTTP-klient. De samme handlinger som CLI'en, velegnet til integration.

Beam Bench' HTTP / WebSocket-API er den samme flade, som CLI'en taler med. Hvis du har et anvendelsestilfælde, der kræver Beam Bench i et miljø uden CLI, f.eks. en webapp, integrationsserver eller mobilapp, skal du bruge HTTP API'et direkte.

Det skal du bruge

Beam Bench installeret.
Den lokale API aktiveret i Edit → Settings → General. Den er som standard slået fra.
En HTTP-klient (curl, dit sprogs HTTP-bibliotek, Postman osv.).

Kontrollér, at API'et er aktiveret

Standardindstillingerne i den aktuelle version er med vilje låst:

Local API: fra.
API Port: 5900.
Allow network devices to connect: fra. Så længe den er slået fra, accepterer serveren kun forbindelser fra denne computer.

Åbn desktopappen, gå til Edit → Settings → General, og slå Local API til. Lad Allow network devices to connect være slået fra for scripts, der kører på den samme computer. Indstillingerne træder i kraft med det samme.

Læs HTTP API-siden, før du binder til netværket på et delt Wi-Fi. API'et har ingen godkendelse og kan flytte maskinen og udløse laseren.

Basis-URL

http://localhost:5900/api/v1

(Eller din maskines LAN-IP i stedet for localhost, når Allow network devices to connect er slået til.)

Trin

1. Kontrollér, at API'et kører

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

Returnerer funktionsskemaet. (Erstat 5900 med din konfigurerede port, hvis du har ændret den.)

2. Inspicér tilstanden

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

3. Åbn et 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. Gengiv designet gennem den kørende server

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. Gengiv kameraoverlayet gennem 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}'

Tilgængelige endpointgrupper

Se afsnittet API-reference, når det er udfyldt, for hele fladen. Vigtige grupper:

/agent, funktioner, tilstand, guide.
/camera, enheder, tilstand, optagelse, overlay, visning, transformation, gengivelse, kalibrering, justering.
/design, beskrivelse, gengivelse, transaktioner.
/projects, åbn, gem, luk, lag, objekter, fortryd/omgør, importér.
/export, svg, dxf, pdf, eps, ai.

Sikkerhed

API-serveren har ingen godkendelse. Den antager, at netværket, den er på, er betroet.

Binding kun til localhost begrænser eksponeringen til den lokale maskine.
Netværksbinding er et separat tilvalg og åbner API'et for alle på det samme LAN. Aktivér det kun på et betroet netværk.

Kontrollér, at det virkede

curl agent/capabilities returnerer JSON.
Et gengivelseskald opretter den ønskede fil.