Περιεχόμενα κρύβω

Λογότυπο ALGO RESTful API

ALGO RESTful API

Προϊόν ALGO RESTful API

Πληροφορίες προϊόντος: Οδηγός RESTful API

Το Algo RESTful API επιτρέπει στους χρήστες να έχουν πρόσβαση, να χειρίζονται και να ενεργοποιούν ενέργειες στα τελικά σημεία Algo IP στο δίκτυό τους μέσω αιτημάτων HTTP/HTTPS. Αυτό το έγγραφο παρέχει ένα ομοιόμορφο και προκαθορισμένο σύνολο λειτουργιών χωρίς κατάσταση που μπορούν να χρησιμοποιηθούν για αλληλεπίδραση με συσκευές Algo. Το API υποστηρίζει αιτήματα HTTP/HTTPS GET, POST και PUT με ωφέλιμα φορτία JSON.

Πιστοποίηση

Υπάρχουν τρεις τύποι ελέγχων ταυτότητας που διατίθενται με το Algo RESTful API:

  • Τυπικός έλεγχος ταυτότητας (ενεργοποιημένος από προεπιλογή)
  • Βασικός έλεγχος ταυτότητας (προαιρετικό)
  • Χωρίς μέθοδο ελέγχου ταυτότητας (δεν συνιστάται, μόνο για σκοπούς δοκιμής)

Οδηγίες χρήσης προϊόντος: RESTful API

Προαπαιτούμενα

Πριν ενεργοποιήσετε το RESTful API, βεβαιωθείτε ότι η συσκευή έχει σύνδεση στο Διαδίκτυο για πρόσβαση στους προρυθμισμένους διακομιστές NTP. Εάν δεν υπάρχει διαθέσιμη σύνδεση στο Διαδίκτυο, διαμορφώστε έναν τοπικό διακομιστή NTP και εισαγάγετε τη διεύθυνση IP του.

Ενεργοποίηση του RESTful API
  1. Συνδεθείτε στη συσκευή web διεπαφή και μεταβείτε στην καρτέλα Advanced Settings Admin.
  2. Κάντε κύλιση προς τα κάτω στην ενότητα Υποστήριξη API και ενεργοποιήστε το RESTful API.
  3. Ορίστε τον επιθυμητό κωδικό πρόσβασης (προεπιλεγμένος κωδικός πρόσβασης: algo). Σημειώστε ότι ο τυπικός έλεγχος ταυτότητας είναι ενεργοποιημένος από προεπιλογή.
Ενεργοποίηση βασικού ελέγχου ταυτότητας (προαιρετικό)
  1. Στο web διεπαφή, μεταβείτε στην καρτέλα System Maintenance και κατεβάστε τη διαμόρφωση file.
  2. Ανοίξτε τη διαμόρφωση file με οποιοδήποτε πρόγραμμα επεξεργασίας κειμένου και προσθέστε την ακόλουθη γραμμή: api.auth.basic = 1
  3. Αποθηκεύστε και ανεβάστε την τροποποιημένη διαμόρφωση file πίσω στη συσκευή χρησιμοποιώντας την Επαναφορά διαμόρφωσης File χαρακτηριστικό στην καρτέλα Συντήρηση συστήματος.
Ενεργοποίηση χωρίς μέθοδο ελέγχου ταυτότητας (προαιρετικό)

Για να ενεργοποιήσετε τη μέθοδο χωρίς έλεγχο ταυτότητας, αφήστε κενό το πεδίο RESTful API Password. Αυτή η μέθοδος δεν συνιστάται και θα πρέπει να χρησιμοποιείται μόνο για σκοπούς δοκιμής, καθώς δεν παρέχει ασφάλεια.

Ενεργοποίηση απλής διεπαφής ελέγχου (προαιρετικό)
  1. στο web διεπαφή, μεταβείτε στην καρτέλα System Maintenance και κατεβάστε τη διαμόρφωση file.
  2. Ανοίξτε τη διαμόρφωση file χρησιμοποιώντας ένα πρόγραμμα επεξεργασίας κειμένου και προσθέστε δύο γραμμές. Αλλάξτε τον κωδικό πρόσβασης που επιθυμείτε.
  3. Διαχειρ.web.sci = 1
  4. Sci.admin.pwd =
  5. Αποθηκεύστε και ανεβάστε την τροποποιημένη διαμόρφωση file πίσω στη συσκευή χρησιμοποιώντας την Επαναφορά διαμόρφωσης File χαρακτηριστικό στην καρτέλα Συντήρηση συστήματος.

Έλεγχος ταυτότητας Sample Code

Παρακαλώ στείλτε email support@algosolutions.com εάν θέλετε έναν τυπικό ή βασικό έλεγχο ταυτότητας sampτον κώδικα.
Για πρόσθετη υποστήριξη, καλέστε 604-454-3792 ή email support@algosolutions.com

Ενημερωτικές Σημειώσεις

Σημείωμα
Η Σημείωση υποδεικνύει χρήσιμες ενημερώσεις, πληροφορίες και οδηγίες που πρέπει να ακολουθήσετε

Αρνηση

Οι πληροφορίες που περιέχονται σε αυτό το έγγραφο πιστεύεται ότι είναι ακριβείς από κάθε άποψη, αλλά δεν είναι εγγυημένες από την Algo. Οι πληροφορίες υπόκεινται σε αλλαγές χωρίς προειδοποίηση και δεν πρέπει να ερμηνεύονται με κανέναν τρόπο ως δέσμευση της Algo ή οποιασδήποτε από τις θυγατρικές ή θυγατρικές της. Η Algo και οι θυγατρικές και οι θυγατρικές της δεν αναλαμβάνουν καμία ευθύνη για τυχόν λάθη ή παραλείψεις σε αυτό το έγγραφο. Αναθεωρήσεις αυτού του εγγράφου ή νέες εκδόσεις του ενδέχεται να εκδοθούν για να ενσωματωθούν τέτοιες αλλαγές. Η Algo δεν αναλαμβάνει καμία ευθύνη για ζημιές ή αξιώσεις που προκύπτουν από οποιαδήποτε χρήση αυτού του εγχειριδίου ή τέτοιων προϊόντων, λογισμικού, υλικολογισμικού και/ή υλικού. Κανένα μέρος αυτού του εγγράφου δεν μπορεί να αναπαραχθεί ή να μεταδοθεί σε οποιαδήποτε μορφή ή με οποιοδήποτε μέσο – ηλεκτρονικό ή μηχανικό – για οποιονδήποτε σκοπό χωρίς γραπτή άδεια από την Algo.
Για πρόσθετες πληροφορίες ή τεχνική βοήθεια στη Βόρεια Αμερική, επικοινωνήστε με την ομάδα υποστήριξης της Algo:

Τεχνική Υποστήριξη Algo
1-604-454-3792
support@algosolutions.com

©2022 Το Algo είναι σήμα κατατεθέν της Algo Communication Products Ltd.
Με την επιφύλαξη παντός δικαιώματος. Όλα τα άλλα εμπορικά σήματα είναι ιδιοκτησία των αντίστοιχων κατόχων τους. Όλες οι προδιαγραφές υπόκεινται σε αλλαγές χωρίς προειδοποίηση.

 ΓΕΝΙΚΟΣ

Εισαγωγή

Αυτό το έγγραφο περιγράφει πώς μπορεί να χρησιμοποιηθεί το Algo RESTful API για πρόσβαση, χειρισμό και ενεργοποίηση ενεργειών σε τερματικά σημεία Algo IP στο δίκτυό σας μέσω αιτημάτων HTTP/HTTPS, καθώς και μερικές διαφορετικές μεθόδους ελέγχου ταυτότητας με διαφορετικά επίπεδα ασφάλειας. Τα συστήματα που ζητούν μπορούν να αλληλεπιδράσουν με συσκευές Algo μέσω ενός ενιαίου και προκαθορισμένου συνόλου λειτουργιών χωρίς κατάσταση που ορίζονται σε αυτό το έγγραφο. Τα αιτήματα γίνονται στο URI ενός πόρου με ωφέλιμο φορτίο JSON και προκαλούν μια απάντηση JSON. Τα αιτήματα HTTP/HTTPS GET, POST και PUT υποβάλλονται σε URI πόρων μαζί με το ωφέλιμο φορτίο JSON (δείτε την ενότητα εντολών για μια λίστα ωφέλιμων φορτίων).

 Πιστοποίηση

Υπάρχουν τρεις τύποι ελέγχου ταυτότητας:

  •  Τυπικό (συνιστάται)
  •  Βασικός
  •  Κανένα (δεν συνιστάται)

Ο τυπικός έλεγχος ταυτότητας χρησιμοποιεί έναν κώδικα ελέγχου ταυτότητας μηνυμάτων που βασίζεται σε Hash (HMAC) με κωδικοποιημένη σύνοψη SHA-256. Ο βασικός έλεγχος ταυτότητας χρησιμοποιεί κωδικοποίηση Base64 και θα πρέπει να χρησιμοποιείται μόνο μέσω HTTPS. Κανένας έλεγχος ταυτότητας δεν πρέπει να χρησιμοποιείται μόνο με εξαιρετική προσοχή, καθώς δεν παρέχει έλεγχο ταυτότητας. Ανατρέξτε στην ενότητα Απαιτήσεις ελέγχου ταυτότητας για περισσότερες λεπτομέρειες.

ΡΥΘΜΙΣΗ ΚΑΙ ΔΙΑΜΟΡΦΩΣΗ

Προαπαιτούμενα
  •  Αυτό το έγγραφο προϋποθέτει ότι το τελικό σημείο Algo εκτελεί την έκδοση υλικολογισμικού 3.3 ή νεότερη.
  •  Η χρονική διαφορά μεταξύ του αιτούντος και των συσκευών Algo θα πρέπει να είναι μικρότερη από 30 δευτερόλεπτα για τη χρήση τυπικού ελέγχου ταυτότητας.
  • Βεβαιωθείτε ότι χρησιμοποιείται το NTP (Network Time Protocol). Οι διευθύνσεις των προσαρμοσμένων διακομιστών NTP μπορούν να διαμορφωθούν στην καρτέλα Προηγμένες ρυθμίσεις → Ώρα.

Σημείωμα
Οι προρυθμισμένοι διακομιστές NTP φιλοξενούνται δημόσια, επομένως απαιτείται σύνδεση στο Διαδίκτυο για την πρόσβαση σε αυτούς. Εάν δεν υπάρχει διαθέσιμη σύνδεση στο Διαδίκτυο, διαμορφώστε έναν τοπικό διακομιστή NTP και εισαγάγετε τη διεύθυνση IP του.

  • Βεβαιωθείτε ότι η ώρα του συστήματος της συσκευής Algo έχει προσαρμοστεί στη σωστή ζώνη ώρας. Αυτό μπορεί να γίνει με πλοήγηση στην καρτέλα Ρυθμίσεις για προχωρημένους → Ώρα.
 Ενεργοποίηση του RESTful API
  1. Συνδεθείτε στο web διεπαφή και μεταβείτε στην καρτέλα Προηγμένες ρυθμίσεις → Διαχειριστής.
  2. Κάντε κύλιση προς τα κάτω στην ενότητα Υποστήριξη API, ενεργοποιήστε το RESTful API και ορίστε τον κωδικό πρόσβασης όπως θέλετε (προεπιλεγμένος κωδικός πρόσβασης: algo)
    Σημείωμα
    Ο τυπικός έλεγχος ταυτότητας είναι ενεργοποιημένος από προεπιλογή.ALGO RESTful API 01
Ενεργοποίηση βασικού ελέγχου ταυτότητας (προαιρετικό)
  1. Στο web διεπαφή, μεταβείτε στην καρτέλα Σύστημα → Συντήρηση και πραγματοποιήστε λήψη της διαμόρφωσης file.
  2. Ανοίξτε τη διαμόρφωση file με οποιοδήποτε πρόγραμμα επεξεργασίας κειμένου και προσθέστε την ακόλουθη γραμμή: api.auth.basic = 1
  3.  Αποθηκεύστε και ανεβάστε την τροποποιημένη διαμόρφωση file πίσω στη συσκευή χρησιμοποιώντας την Επαναφορά διαμόρφωσης File χαρακτηριστικό στην καρτέλα Σύστημα → Συντήρηση.
Χωρίς μέθοδο ελέγχου ταυτότητας (προαιρετικό)

Για να ενεργοποιήσετε τη μέθοδο χωρίς έλεγχο ταυτότητας, αφήστε κενό το πεδίο RESTful API Password. Αυτή η μέθοδος δεν συνιστάται και θα πρέπει να χρησιμοποιείται μόνο για σκοπούς δοκιμής, καθώς δεν παρέχει ασφάλεια.

Ενεργοποίηση απλής διεπαφής ελέγχου (προαιρετικό)
  1. στο web διεπαφή, μεταβείτε στην καρτέλα Σύστημα → Συντήρηση και πραγματοποιήστε λήψη της διαμόρφωσης file.
  2.  Ανοίξτε τη διαμόρφωση file χρησιμοποιώντας ένα πρόγραμμα επεξεργασίας κειμένου και προσθέστε δύο γραμμές. Αλλάξτε το στον κωδικό πρόσβασης που επιθυμείτε. Διαχειρ.web.sci = 1
    Sci.admin.pwd =
  3.  Αποθηκεύστε και ανεβάστε την τροποποιημένη διαμόρφωση file πίσω στη συσκευή χρησιμοποιώντας την Επαναφορά διαμόρφωσης File χαρακτηριστικό στην καρτέλα Σύστημα → Συντήρηση.

ΑΠΑΙΤΗΣΕΙΣ ΑΥΘΕΝΤΙΚΟΤΗΤΑΣ

Παρακαλώ στείλτε email support@algosolutions.com εάν θέλετε έναν τυπικό ή βασικό έλεγχο ταυτότητας sampτον κώδικα.

Τυπικό αίτημα ελέγχου ταυτότητας με ωφέλιμο φορτίο JSON

Απαιτούμενες κεφαλίδες στο αίτημα HTTP/HTTPS
> Τύπος περιεχομένου: "application/json"
> Περιεχόμενο-MD5: [content_md5] Π.χample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Εξουσιοδότηση: hmac admin:[nonce]:[hmac_output]
Οι κεφαλίδες εξουσιοδότησης αποτελούνται από:

  1. Η συμβολοσειρά "hmac admin" ακολουθούμενη από άνω και κάτω τελεία ":".
  2. Nonce – Μια τυχαία ή μη επαναλαμβανόμενη τιμή, ακολουθούμενη από άνω και κάτω τελεία «:».
  3. Hmac_output – δημιουργείται από τον κωδικό πρόσβασης RESTful API (μυστικό κλειδί) που έχει διαμορφωθεί στη συσκευή σας και την είσοδο HMAC, όπως αναφέρεται παρακάτω:
    [request_method]:[request_uri]:[content_md5]:[content_type]:[timeestamp]:[όχι]

Είσοδος HMAC π.χample: (χρησιμοποιώντας το 'algo' ως μυστικό κλειδί)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Δημιουργία HMAC με κωδικό πρόσβασης και συμβολοσειρά εισόδου HMAC ως σύνοψη με χρήση SHA-256:
Έξοδος HMAC π.χample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Ημερομηνία: ημέρα, ημερομηνία μήνα, έτος hr:min:sec GMT
Example
Ημερομηνία: Πέμπτη, 22 Σεπτεμβρίου 2022 02:33:07 GMT
Τυπικός έλεγχος ταυτότητας με ωφέλιμο φορτίο π.χample:

ALGO RESTful API 02

 Τυπικό αίτημα ελέγχου ταυτότητας χωρίς ωφέλιμο φορτίο JSON

Πανομοιότυπο με το 3.1 με τις κεφαλίδες που σχετίζονται με το περιεχόμενο/την είσοδο hmac παραλείπονται.
Είσοδος HMAC: [request_method]:[request_uri]:[timestamp]:[nonce] Είσοδος HMAC π.χample: (χρησιμοποιώντας το 'algo' ως μυστικό κλειδί)
GET:/api/settings/audio.page.vol:1601312252:49936
Δημιουργήστε HMAC με κωδικό πρόσβασης και συμβολοσειρά εισόδου HMAC χρησιμοποιώντας το SHA-256:
Έξοδος HMAC π.χample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Τυπικός έλεγχος ταυτότητας χωρίς ωφέλιμο φορτίο π.χample:

ALGO RESTful API 03

 Βασικό αίτημα ελέγχου ταυτότητας

Αυτή η μέθοδος ελέγχου ταυτότητας θα πρέπει να χρησιμοποιείται με προσοχή, καθώς είναι λιγότερο ασφαλής από την τυπική μέθοδο.

Εξουσιοδότηση: Basic [base64]
Example:
Εξουσιοδότηση: Βασικό YWRtaW46YWxnbwo=
Βασικός έλεγχος ταυτότητας π.χample:
ALGO RESTful API 04

ΕΝΤΟΛΕΣ

 Εντολές RESTful API

Παρακάτω είναι μια λίστα με όλες τις υποστηριζόμενες εντολές API.

Σημείωμα
Ένα αίτημα PUT αλλάζει ή δημιουργεί έναν μόνιμο πόρο που επιβιώνει μετά την επανεκκίνηση, ενώ ένα αίτημα POST ελέγχει μόνο τη συσκευή για την τρέχουσα περίοδο λειτουργίας.

Περιγραφή Μέθοδος URI Φορτίο επί πληρωμή Παράμετροι Απόδοση Example Προϊόν FW
Ανακτήστε την τιμή μιας συγκεκριμένης παραμέτρου.  ΠΑΙΡΝΩ /api/settings/[key-name] Ex./api/settings/audio.page.vol  N/A  {“audio.page.vol”: “-18dB”}  Ολοι  > 3.3
Επιστρέψτε το επίπεδο θορύβου περιβάλλοντος μετρημένο σε ντεσιμπέλ. Η αντιστάθμιση θορύβου περιβάλλοντος πρέπει να είναι ενεργοποιημένη στην καρτέλα Βασικές ρυθμίσεις -> Χαρακτηριστικά. ΠΑΙΡΝΩ /api/info/audio.noise.level N/A {"audio.noise.level": 72}  Ηχεία Εμφάνιση Ηχείων > 3.3
 Εξαγάγετε την κατάσταση του ακροδέκτη εισόδου ρελέ. ΠΑΙΡΝΩ /api/info/input.relay.status N/A  

{"input.relay.status": "idle"} ή {"input.relay.status": "active"}

Όλα τα προϊόντα με είσοδο ρελέ, εκτός από το 8063. Δείτε παρακάτω. > 4.1
 Εξαγάγετε την κατάσταση των ακροδεκτών Input 1 ή Input 2.  ΠΑΙΡΝΩ /api/info/input.relay1.status ή /api/info/input.relay2.status  N/A {"input.relay1.status": "idle"} ή {"input.relay1.status": "active"}  8063  > 4.1
Ανακτήστε τη λίστα των τόνων fileείναι εγκατεστημένο αυτήν τη στιγμή.  ΠΑΙΡΝΩ  /api/info/tonelist  

N/A

{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}  Ολοι  > 5.0
Ανακτήστε τις πληροφορίες της συσκευής που εμφανίζονται στη σελίδα Κατάσταση.  ΠΑΙΡΝΩ  /api/info/status  N/A  Πλήρης λίστα πληροφοριών από την καρτέλα Κατάσταση.  Ολοι  > 5.4
Ανακτήστε τις πληροφορίες προϊόντος που εμφανίζονται στη σελίδα Πληροφορίες.  ΠΑΙΡΝΩ /api/info/about  N/A  Όλες οι πληροφορίες υπάρχουν στην καρτέλα Πληροφορίες. Ολοι > 5.4
Ενεργοποιήστε το στροβοσκόπιο με τις επιθυμητές παραμέτρους χρώματος και σχεδίου. ΘΕΣΗ /api/controls/strobe/start μοτίβο: {0 – 15}
color1: {μπλε, κόκκινο, πορτοκαλί, πράσινο} color2: {μπλε, κόκκινο, πορτοκαλί, πράσινο} ledlvl: {1 – 255}
κατοχή: {αληθές, ψευδές}
N/A  8128(G2)
8138
8190S
> 3.3
 Σταματήστε το στροβοσκόπιο.  ΘΕΣΗ  /api/controls/strobe/stop  N/A  N/A 8128(G2)
8138
8190S
> 3.3
Παίξτε έναν ήχο μία φορά ή επαναλάβετε. ΘΕΣΗ /api/controls/tone/start διαδρομή: {tone} δηλ. κουδούνισμα.wav
βρόχος: {true, false} ή {0, 1}
π.χ. {“path”:”chime.wav”, “loop”:true}
N/A Ηχεία 8301
8373
8028(G2)
8201
8039
> 3.3
Σταματήστε τον τόνο. ΘΕΣΗ /api/controls/tone/stop N/A N/A Ηχεία 8301
8373
8028(G2)
8201
8039
> 3.3
Καλέστε μια επέκταση τηλεφώνου με ένα προ-ηχογραφημένο μήνυμα. ΘΕΣΗ /api/controls/call/start  {“επέκταση”:”2099″,
“tone”:”gong.wav”, “interval”:”0″, “maxdur”:”10″}
N/A Ηχεία 8301
8410
8420
> 3.3
Τερματίστε την κλήση. ΘΕΣΗ /api/controls/call/stop N/A N/A Ηχεία 8301
8410
8420
> 3.3
Ξεκινήστε μια μονόδρομη κλήση σελίδας. Η συσκευή θα λάβει τη ροή ήχου από την επέκταση προορισμού.  ΘΕΣΗ  /api/controls/call/page  {"επέκταση":" ”}  N/A Ηχεία 8410
8420
 > 5.3.4
Επανεκκινήστε το τελικό σημείο προορισμού. ΘΕΣΗ /api/controls/reboot N/A N/A Ολοι > 3.3
Ξεκλειδώστε την πόρτα. Το "τοπικό" ελέγχει το τοπικό ρελέ "netdc1" ελέγχει τον ελεγκτή πόρτας απομακρυσμένου δικτύου (8063) ΘΕΣΗ /api/controls/πόρτα/ξεκλείδωμα doorid: {local, netdc1}
*Προαιρετικός
N/A 8039
8028(G2)
8201
8063
> 3.3
Κλείδωσε την πόρτα. ΘΕΣΗ /api/controls/πόρτα/κλείδωμα  doorid: {local, netdc1}
*Προαιρετικός
N/A 8039
8028(G2)
8201
8063
> 3.3
Ενεργοποιήστε το ρελέ εξόδου 24v. ΘΕΣΗ api/controls/24v/enable N/A N/A 8063 > 5.0
Απενεργοποιήστε το ρελέ εξόδου 24v. ΘΕΣΗ api/controls/24v/απενεργοποίηση N/A N/A 8063 > 5.0
Ενεργοποιήστε το ρελέ εξόδου. ΘΕΣΗ /api/controls/relay/enable N/A N/A 8063 > 5.0
Απενεργοποιήστε το ρελέ εξόδου. ΘΕΣΗ /api/controls/relay/disable N/A N/A 8063 > 5.0
Ελέγξτε τον διακομιστή υλικολογισμικού της Algo για την πιο πρόσφατη έκδοση υλικολογισμικού.  ΘΕΣΗ  /api/controls/αναβάθμιση/τσεκ  N/A {"έκδοση": "ενημερώθηκε"} ή
{"έκδοση": " ”}
 Ολοι  > 4.1
 Ελέγξτε τον διακομιστή υλικολογισμικού της Algo για την πιο πρόσφατη έκδοση υλικολογισμικού και κάντε αναβάθμιση σε αυτήν την έκδοση. ΘΕΣΗ /api/controls/αναβάθμιση/έναρξη N/A {“status”: “updated”} ή
{“status”: “αναβάθμιση », «url”: url>} ή
{"status": " ”}
Ολοι > 4.1
Εμφανίστε μια εικόνα ή ένα μοτίβο στην οθόνη.  ΘΕΣΗ  /api/controls/screen/start  Βλέπω παρακάτω  N/A 8410
8420
 > 5.3.4
Σταματήστε το μοτίβο οθόνης και επιστρέψτε στην προεπιλεγμένη οθόνη.  ΘΕΣΗ  /api/controls/screen/stop  N/A  N/A 8410
8420
 > 5.3.4
Επανεκκινήστε την κύρια εφαρμογή. ΘΕΣΗ /api/controls/reload N/A N/A Ολοι > 5.3.4
Ξεκινήστε να ακούτε μια απευθείας ροή ήχου. Διαμορφώστε τον αριθμό θύρας στην οποία αποστέλλεται η ροή. ΘΕΣΗ /api/controls/rx/start {"λιμάνι": } N/A Ολοι   > 5.3.4
Σταματήστε να ακούτε απευθείας ροή ήχου. ΘΕΣΗ  /api/controls/rx/stop  N/A  N/A  Ολοι  > 5.3.4
Ρυθμίστε τη λειτουργία πολλαπλής εκπομπής. ΒΑΖΩ /api/state/mcast/update/ {"mode":"αποστολέας", "address": , «λιμάνι»: , "type":"rtp"} ή {"mode":"sender", "address": , «λιμάνι»: , "type":"poly", "group":1}
**Σημείωση**: Εάν χρησιμοποιηθούν χειριστήρια/τόνος/έναρξη πριν από αυτήν την εντολή, ο ήχος θα παίξει χρησιμοποιώντας τις τρέχουσες ρυθμίσεις στο web Διεπαφή χρήστη
N/A 8301 > 5.0
Εισαγάγετε μια τιμή σε μια συγκεκριμένη παράμετρο από το ωφέλιμο φορτίο JSON. ΒΑΖΩ /api/ρυθμίσεις παράμετρος: {value}
π.χ. {"audio.page.vol": "-3dB"}
N/A 8180(G2)
8186
8190
8190S
8301
8373
> 3.3
 Εντολές απλής διεπαφής ελέγχου (SCI).

Όλες οι εντολές SCI είναι αιτήματα GET και έχουν τις κοινές παραμέτρους "usi" και "admin" για έλεγχο ταυτότητας.
Example:
ΛΑΒΕ http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

 Περιγραφή  URI Επιπλέον Φορτίο επί πληρωμή Παράμετροι Προϊόντα  FW
Ξεκλειδώστε την πόρτα.
Το "τοπικό" ελέγχει το τοπικό ρελέ "netdc1" ελέγχει τον ελεγκτή πόρτας απομακρυσμένου δικτύου (8063)
/sci/controls/do ή/ξεκλείδωμα doorid: {local, netdc1}
*Προαιρετικός
8039
8028(G2)
8201
8063
> 3.3
Κλείδωσε την πόρτα. /sci/controls/do ή/lock doorid: {local, netdc1}
*Προαιρετικός
8039
8028(G2)
8201
8063
> 3.3
Παίξτε έναν ήχο μία φορά ή επαναλάβετε.  /sci/controls/to ne/start διαδρομή: {tone} δηλ. κουδούνισμα.wav
βρόχος: {true, false} ή {0, 1}
Ολοι  > 3.3
Σταματήστε τον τόνο. /sci/controls/to ne/stop  N/A  Ολοι  > 3.3
Ενεργοποιήστε το στροβοσκόπιο με τις επιθυμητές παραμέτρους χρώματος και σχεδίου. /sci/controls/strobe/start μοτίβο: {0 – 15} χρώμα1: {μπλε, κόκκινο, πορτοκαλί, πράσινο}
χρώμα2: {μπλε, κόκκινο, πορτοκαλί, πράσινο}
ledlvl: {1 – 255} holdover: {true, false}
8128(G2)
8138
8190S
> 3.3
 Σταματήστε το στροβοσκόπιο.  /sci/controls/strobe/stop  N/A 8128(G2)
8138
8190S
 > 3.3

Έγγραφα / Πόροι

ALGO RESTful API [pdf] Οδηγός χρήστη
AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
ALGO RESTful API [pdf] Οδηγός χρήστη
AL061-GU-CP000API-230717, RESTful API, RESTful, API

Αναφορές

Αφήστε ένα σχόλιο

Η διεύθυνση email σας δεν θα δημοσιευτεί. Τα υποχρεωτικά πεδία επισημαίνονται *