Χρήση του 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. Διατηρήστε απενεργοποιημένη την επιλογή Να επιτρέπεται η σύνδεση συσκευών δικτύου για script που εκτελούνται στον ίδιο υπολογιστή. Οι ρυθμίσεις εφαρμόζονται αμέσως.

Διαβάστε τη σελίδα 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. Αποδώστε την επικάλυψη κάμερας μέσω του 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}'

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

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

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

Ασφάλεια

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

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

Επαληθεύστε ότι λειτούργησε

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