Χρήση του HTTP API

Χειριστείτε το Beam Bench από οποιονδήποτε πελάτη HTTP. Οι ίδιες λειτουργίες με το CLI, με εύκολη ενσωμάτωση.

Το HTTP / WebSocket API του Beam Bench είναι η ίδια διεπαφή που χρησιμοποιεί το CLI. Αν έχετε μια περίπτωση χρήσης που απαιτεί το Beam Bench σε περιβάλλον εκτός CLI, όπως εφαρμογή web, διακομιστή ενσωμάτωσης ή εφαρμογή για κινητές συσκευές, χρησιμοποιήστε απευθείας το HTTP API.

Τι χρειάζεστε

Εγκατεστημένο Beam Bench.
Ενεργοποιημένο το Τοπικό API από Επεξεργασία → Ρυθμίσεις → Γενικά. Είναι απενεργοποιημένο από προεπιλογή.
Έναν πελάτη HTTP (curl, τη βιβλιοθήκη HTTP της γλώσσας σας, το Postman κ.λπ.).

Επαλήθευση ότι το API είναι ενεργοποιημένο

Οι προεπιλεγμένες ρυθμίσεις στην τρέχουσα έκδοση είναι σκόπιμα αυστηρά περιορισμένες:

Τοπικό API: απενεργοποιημένο.
Θύρα API: 5900.
Να επιτρέπεται η σύνδεση συσκευών δικτύου: απενεργοποιημένο. Όσο παραμένει απενεργοποιημένο, ο διακομιστής δέχεται συνδέσεις μόνο από αυτόν τον υπολογιστή.

Ανοίξτε την εφαρμογή για υπολογιστές, μεταβείτε στις Επεξεργασία → Ρυθμίσεις → Γενικά και ενεργοποιήστε το Τοπικό API. Αφήστε την επιλογή Να επιτρέπεται η σύνδεση συσκευών δικτύου απενεργοποιημένη για σενάρια που εκτελούνται στον ίδιο υπολογιστή. Οι ρυθμίσεις εφαρμόζονται αμέσως.

Διαβάστε τη σελίδα HTTP API πριν συνδεθείτε στο δίκτυο μέσω κοινόχρηστου Wi-Fi. Το API δεν διαθέτει έλεγχο ταυτότητας και μπορεί να κινήσει το μηχάνημα και να ενεργοποιήσει το λέιζερ.

Βασικό URL

http://localhost:5900/api/v1

(Ή χρησιμοποιήστε τη διεύθυνση IP του υπολογιστή σας στο LAN αντί για το localhost, όταν είναι ενεργοποιημένη η επιλογή Να επιτρέπεται η σύνδεση συσκευών δικτύου.)

Βήματα

1. Επαλήθευση ότι το API λειτουργεί

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

Επιστρέφει το σχήμα δυνατοτήτων. (Αντικαταστήστε το 5900 με τη ρυθμισμένη θύρα σας, αν την έχετε αλλάξει.)

2. Έλεγχος κατάστασης

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

3. Άνοιγμα έργου

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

4. Απόδοση του σχεδίου, χωρίς περιβάλλον γραφικών

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. Λήψη κατάστασης κάμερας

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

6. Απόδοση επικάλυψης κάμερας, απαιτείται η εφαρμογή

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

Διαθέσιμες ομάδες endpoint

Ανατρέξτε στην ενότητα αναφοράς API, όταν συμπληρωθεί, για την πλήρη διεπαφή. Οι κύριες ομάδες είναι:

/agent, δυνατότητες, κατάσταση, οδηγός.
/camera, συσκευές, κατάσταση, λήψη, επικάλυψη (εμφάνιση, μετασχηματισμός, απόδοση), βαθμονόμηση, ευθυγράμμιση.
/design, περιγραφή, απόδοση, συναλλαγές.
/projects, άνοιγμα, αποθήκευση, κλείσιμο, επίπεδα, αντικείμενα, αναίρεση/επανάληψη, εισαγωγή.
/export, svg, dxf, pdf, eps, ai.

Ασφάλεια

Ο διακομιστής API δεν διαθέτει έλεγχο ταυτότητας. Θεωρεί ότι το δίκτυο στο οποίο βρίσκεται είναι αξιόπιστο.

Η δέσμευση μόνο στο localhost περιορίζει την έκθεση στον τοπικό υπολογιστή.
Η δέσμευση στο δίκτυο είναι ξεχωριστή επιλογή και ανοίγει το API σε οποιονδήποτε βρίσκεται στο ίδιο LAN. Ενεργοποιήστε την μόνο σε αξιόπιστο δίκτυο.

Επαλήθευση λειτουργίας

Το curl agent/capabilities επιστρέφει JSON.
Μια κλήση απόδοσης δημιουργεί το ζητούμενο αρχείο.