Brug af HTTP API'et

Styr Beam Bench fra enhver HTTP-klient. Samme handlinger som i CLI'en, velegnet til integrationer.

Beam Bench' HTTP- og WebSocket-API er den samme grænseflade, som CLI'en bruger. Hvis du har brug for at anvende Beam Bench i et miljø uden CLI, f.eks. en webapp, en integrationsserver eller en mobilapp, kan du bruge HTTP API'et direkte.

Det skal du bruge

Beam Bench installeret.
Local API aktiveret under Edit → Settings → General. Funktionen er som standard deaktiveret.
En HTTP-klient (curl, dit sprogs HTTP-bibliotek, Postman osv.).

Kontrollér, at API'et er aktiveret

Standardindstillingerne i den aktuelle version er bevidst låst:

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

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

Læs HTTP API-siden, før du binder API'et 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 aktiveret.)

Trin

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

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

Returnerer skemaet for funktionerne. (Erstat 5900 med den 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 uden brugerflade

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. Gengiv kameraoverlejringen, kræver 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}'

Tilgængelige endpointgrupper

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

/agent, funktioner, tilstand, vejledning.
/camera, enheder, tilstand, optagelse, overlejring (visning, transformation, gengivelse), kalibrering, justering.
/design, beskrivelse, gengivelse, transaktioner.
/projects, åbning, lagring, lukning, lag, objekter, fortryd/gentag, import.
/export, svg, dxf, pdf, eps, ai.

Sikkerhed

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

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

Kontrollér, at det virkede

curl agent/capabilities returnerer JSON.
Et kald til gengivelse opretter den ønskede fil.