Utilisation de l’API HTTP

Pilotez Beam Bench depuis n’importe quel client HTTP. Mêmes opérations que l’interface CLI, adaptée 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 autre que la CLI (application web, serveur d’intégration, application mobile), utilisez directement l’API HTTP.

Ce dont vous avez besoin

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 paramètres par défaut de la version actuelle sont volontairement verrouillés :

API locale : désactivée.
Port de l’API : 5900.
Autoriser les périphériques réseau à se connecter : désactivé. Tant que cette option reste désactivée, le serveur n’accepte des 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 périphériques 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 la lier au réseau sur un Wi-Fi partagé. L’API ne comporte 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 au lieu de localhost, lorsque Autoriser les périphériques réseau à se connecter est activé.)

Étapes

1. Vérifier que l’API est opérationnelle

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

Renvoie le schéma des capacités. (Remplacez 5900 par votre 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. Rendre le dessin (sans interface)

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. Rendre la superposition de la caméra (application requise)

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 l’interface complète. Principaux groupes :

/agent, capacités, état, guide.
/camera, périphériques, état, capture, superposition (affichage, transformation, rendu), étalonnage, alignement.
/design, description, rendu, transactions.
/projects, ouvrir, enregistrer, fermer, calques, objets, annuler/rétablir, importer.
/export, svg, dxf, pdf, eps, ai.

Sécurité

Le serveur API ne comporte aucune authentification. Il suppose que le réseau sur lequel il se trouve est fiable.

La liaison à localhost uniquement limite l’exposition à la machine locale.
La liaison réseau est une option distincte et ouvre l’API à toute personne présente sur le même LAN. Activez-la uniquement sur un réseau fiable.

Vérifier que cela a fonctionné

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