Utiliser l'API HTTP

Pilotez Beam Bench depuis n'importe quel client HTTP. Les mêmes opérations que la CLI, adaptées aux intégrations.

L'API HTTP / WebSocket de Beam Bench est la même interface que celle utilisée par la CLI. Si votre cas d'utilisation nécessite Beam Bench dans un environnement sans CLI, comme une application web, un serveur d'intégration ou une application mobile, utilisez directement l'API HTTP.

Ce qu'il vous faut

Beam Bench installé.
L'API locale activée dans Édition → Paramètres → Général. Elle est désactivée par défaut.
Un client HTTP (curl, la bibliothèque HTTP de votre langage, Postman, etc.).

Vérifier que l'API est activée

Les valeurs par défaut de la version actuelle sont délibérément verrouillées :

API locale : désactivée.
Port de l'API : 5900.
Autoriser les appareils réseau à se connecter : désactivé. Tant que cette option reste désactivée, le serveur n'accepte les connexions que depuis cet ordinateur.

Ouvrez l'application de bureau, accédez à Édition → Paramètres → Général, puis activez API locale. Laissez Autoriser les appareils réseau à se connecter désactivé pour les scripts exécutés sur le même ordinateur. Les paramètres prennent effet immédiatement.

Lisez la page de l'API HTTP avant de lier l'API au réseau sur un Wi-Fi partagé. L'API n'a aucune authentification et peut déplacer la machine et déclencher le laser.

URL de base

http://localhost:5900/api/v1

(ou l'adresse IP LAN de votre machine à la place de localhost, lorsque Autoriser les appareils réseau à se connecter est activé.)

Étapes

1. Vérifier que l'API fonctionne

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

Renvoie le schéma des capacités. (Remplacez 5900 par le port configuré si vous l'avez modifié.)

2. Inspecter l'état

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

3. Ouvrir un projet

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

4. Effectuer le rendu de la conception via le serveur en cours d'exécution

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. Obtenir l'état de la caméra

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

6. Effectuer le rendu de la superposition de caméra via le frontend de l'application

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

Groupes de points de terminaison disponibles

Consultez la section Référence de l'API, lorsqu'elle sera renseignée, pour connaître l'ensemble de l'interface. Principaux groupes :

/agent, capacités, état, guide.
/camera, appareils, état, capture, superposition (affichage, transformation, rendu), étalonnage, alignement.
/design, description, rendu, transactions.
/projects, ouverture, enregistrement, fermeture, calques, objets, annulation/rétablissement, importation.
/export, svg, dxf, pdf, eps, ai.

Sécurité

Le serveur d'API n'a aucune authentification. Il considère que le réseau sur lequel il se trouve est fiable.

Une liaison limitée à localhost restreint l'exposition à l'ordinateur local.
La liaison réseau est une activation distincte et facultative qui ouvre l'API à toute personne présente sur le même LAN. Activez-la uniquement sur un réseau fiable.

Vérifier le résultat

curl agent/capabilities renvoie du JSON.
Un appel de rendu produit le fichier demandé.