ALGO RESTful API

Tooteteave: RESTful API juhend

Algo RESTful API võimaldab kasutajatel HTTP/HTTPS-i päringute kaudu oma võrgus Algo IP lõpp-punktidele juurdepääsu, nendega manipuleerida ja toiminguid käivitada. See dokument pakub ühtset ja eelnevalt määratletud olekuta toimingute komplekti, mida saab kasutada Algo seadmetega suhtlemiseks. API toetab HTTP/HTTPS GET-, POST- ja PUT-päringuid JSON-i kasulike koormustega.

Autentimine

Algo RESTful API-ga on saadaval kolme tüüpi autentimised:

• Standardne autentimine (vaikimisi lubatud)
• Lihtne autentimine (valikuline)
• Autentimismeetodit pole (ei ole soovitatav; ainult testimise eesmärgil)

Toote kasutusjuhised: RESTful API

Eeldused

Enne RESTful API lubamist veenduge, et seadmel oleks eelkonfigureeritud NTP-serveriteni jõudmiseks Interneti-ühendus. Kui Interneti-ühendust pole saadaval, konfigureerige kohalik NTP-server ja sisestage selle IP-aadress.

RESTful API lubamine

1. Logige seadmesse sisse web liides ja navigeerige vahekaardile Täpsemad sätted Administraator.
2. Kerige alla jaotiseni API tugi ja lubage RESTful API.
3. Määrake soovitud parool (vaikeparool: algo). Pange tähele, et standardne autentimine on vaikimisi lubatud.

Põhiautentimise lubamine (valikuline)

1. Aastal web liides, navigeerige vahekaardile Süsteemi hooldus ja laadige alla konfiguratsioon file.
2. Avage konfiguratsioon file mis tahes tekstiredaktoriga ja lisage järgmine rida: api.auth.basic = 1
3. Salvestage ja laadige üles muudetud konfiguratsioon file konfiguratsiooni taastamise abil tagasi seadmesse File funktsioon vahekaardil Süsteemi hooldus.

Autentimiseta meetodi lubamine (valikuline)

Autentimiseta meetodi lubamiseks jätke RESTful API parooli väli tühjaks. See meetod ei ole soovitatav ja seda tuleks kasutada ainult testimise eesmärgil, kuna see ei paku turvalisust.

Lihtsa juhtimisliidese lubamine (valikuline)

1. peal web liides, navigeerige vahekaardile Süsteemi hooldus ja laadige alla konfiguratsioon file.
2. Avage konfiguratsioon file tekstiredaktoriga ja lisage kaks rida. Muutke soovitud parool.
3. Adminweb.sci = 1
4. Sci.admin.pwd =
5. Salvestage ja laadige üles muudetud konfiguratsioon file konfiguratsiooni taastamise abil tagasi seadmesse File funktsioon vahekaardil Süsteemi hooldus.

Autentimine Sample Kood

Palun saatke e-kiri support@algosolutions.com kui soovite standardset või põhiautentimist sampkoodi.
Lisatoe saamiseks helistage 604-454-3792 või meili support@algosolutions.com

Teavitused

Märkus
Märkus viitab kasulikele uuendustele, teabele ja juhistele, mida tuleks järgida

Vastutusest loobumine

Selles dokumendis sisalduvat teavet peetakse kõigis aspektides täpseks, kuid Algo seda ei garanteeri. Teavet võidakse ette teatamata muuta ja seda ei tohiks mingil viisil tõlgendada kui Algo ega tema sidus- või tütarettevõtete kohustust. Algo ning tema sidus- ja tütarettevõtted ei vastuta selles dokumendis esinevate vigade või puuduste eest. Selliste muudatuste lisamiseks võidakse välja anda selle dokumendi muudatusi või selle uusi väljaandeid. Algo ei vastuta kahjude või nõuete eest, mis tulenevad selle juhendi või selliste toodete, tarkvara, püsivara ja/või riistvara kasutamisest. Ühtegi selle dokumendi osa ei tohi ilma Algo kirjaliku loata ühelgi eesmärgil reprodutseerida ega edastada ühelgi kujul ega mistahes vahenditega (elektrooniliselt või mehaaniliselt).
Põhja-Ameerikas täiendava teabe või tehnilise abi saamiseks võtke ühendust Algo tugimeeskonnaga:

Algo tehniline tugi
1-604-454-3792
support@algosolutions.com

©2022 Algo on Algo Communication Products Ltd registreeritud kaubamärk.
Kõik õigused kaitstud. Kõik muud kaubamärgid on nende vastavate omanike omand. Kõiki tehnilisi andmeid võidakse ette teatamata muuta.

 ÜLDINE

Sissejuhatus

Selles dokumendis kirjeldatakse, kuidas Algo RESTful API-t saab kasutada teie võrgus olevatele Algo IP lõpp-punktidele juurdepääsuks, nende manipuleerimiseks ja toimingute käivitamiseks HTTP/HTTPS-i päringute kaudu, aga ka paari erinevat erineva turbetasemega autentimismeetodit. Taotlevad süsteemid saavad Algo seadmetega suhelda läbi selles dokumendis määratletud ühtse ja eelnevalt määratletud olekuta toimingute komplekti. Päringud tehakse JSON-i kasuliku koormusega ressursi URI-le ja kutsutakse esile JSON-vastus. HTTP/HTTPS GET-, POST- ja PUT-päringud tehakse ressursi URI-le koos JSON-i kasuliku koormusega (kasulike koormuste loendi leiate käskude jaotisest).

 Autentimine

Autentimist on kolme tüüpi:

•  Standardne (soovitatav)
•  Põhiline
•  Puudub (pole soovitatav)

Standardne autentimine kasutab räsipõhist sõnumi autentimise koodi (HMAC) koos SHA-256 kodeeritud kokkuvõttega. Põhiautentimine kasutab Base64 kodeeringut ja seda tuleks kasutada ainult HTTPS-i kaudu. Autentimist ei tohiks kasutada ainult äärmise ettevaatusega, kuna see ei anna autentimist. Lisateavet leiate jaotisest Autentimisnõuded.

SEADISTAMINE JA SEADISTAMINE

Eeldused

•  See dokument eeldab, et Algo lõpp-punktis töötab püsivara versioon 3.3 või uuem.
•  Ajavahe taotleja ja Algo seadmete vahel peaks standardse autentimise kasutamiseks olema väiksem kui 30 sekundit.
• Veenduge, et NTP (Network Time Protocol) oleks kasutusel. Kohandatud NTP-serverite aadresse saab konfigureerida vahekaardil Täpsemad sätted → Aeg.

Märkus
Eelkonfigureeritud NTP-serverid on avalikult hostitud, seetõttu on nendeni jõudmiseks vajalik Interneti-ühendus. Kui Interneti-ühendust pole saadaval, konfigureerige kohalik NTP-server ja sisestage selle IP-aadress.

• Veenduge, et Algo seadme süsteemiaeg on reguleeritud õigele ajavööndile. Seda saab teha vahekaardile Täpsemad sätted → Aeg.

 RESTful API lubamine

1. Logige sisse web liides ja navigeerige vahekaardile Täpsemad sätted → Administraator.
2. Kerige alla jaotiseni API tugi, lubage RESTful API ja määrake soovitud parool (vaikeparool: algo)
   Märkus
   Standardne autentimine on vaikimisi lubatud.

Põhiautentimise lubamine (valikuline)

1. Aastal web liides, navigeerige vahekaardile Süsteem → Hooldus ja laadige alla konfiguratsioon file.
2. Avage konfiguratsioon file mis tahes tekstiredaktoriga ja lisage järgmine rida: api.auth.basic = 1
3.  Salvestage ja laadige üles muudetud konfiguratsioon file konfiguratsiooni taastamise abil tagasi seadmesse File funktsioon vahekaardil Süsteem → Hooldus.

Autentimismeetodit pole (valikuline)

Autentimiseta meetodi lubamiseks jätke RESTful API parooli väli tühjaks. See meetod ei ole soovitatav ja seda tuleks kasutada ainult testimise eesmärgil, kuna see ei paku turvalisust.

Lihtsa juhtimisliidese lubamine (valikuline)

1. peal web liides, navigeerige vahekaardile Süsteem → Hooldus ja laadige alla konfiguratsioon file.
2.  Avage konfiguratsioon file tekstiredaktoriga ja lisage kaks rida. Muuda soovitud paroolile. Adminweb.sci = 1
   Sci.admin.pwd =
3.  Salvestage ja laadige üles muudetud konfiguratsioon file konfiguratsiooni taastamise abil tagasi seadmesse File funktsioon vahekaardil Süsteem → Hooldus.

AUTENTIMISNÕUDED

Palun saatke e-kiri support@algosolutions.com kui soovite standardset või põhiautentimist sampkoodi.

Standardne autentimistaotlus JSON-i kasuliku koormusega

HTTP/HTTPS-i päringus nõutavad päised
> Sisu tüüp: „rakendus/json”
> Sisu-MD5: [content_md5] Ntample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Autoriseerimine: hmac admin:[nonce]:[hmac_output]
Volituste päised koosnevad:

1. String "hmac admin", millele järgneb koolon ":".
2. Nonce – juhuslik või mittekorduv väärtus, millele järgneb koolon ':'.
3. Hmac_output – genereerib teie seadmes konfigureeritud RESTful API parool (salajane võti) ja HMAC-sisend, nagu allpool kirjeldatud:
   [päringu_meetod]:[päringu_uri]:[sisu_md5]:[sisu_tüüp]:[aegamp]:[ei ole]

HMAC sisend ntample: (kasutades salavõtmena 'algo')
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Looge HMAC parooliga ja HMAC-i sisendstring kokkuvõttena, kasutades SHA-256:
HMAC väljund ntample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Kuupäev: päev, kuupäev kuu, aasta hr:min:sec GMT
Example
Kuupäev: neljapäev, 22. september 2022 02:33:07 GMT
Tavaline autentimine kasuliku koormusega, ntample:

 Standardne autentimistaotlus ilma JSON-i kandeta

Identne 3.1-ga, sisuga seotud päised/hmaci sisend on välja jäetud.
HMAC-sisend: [päringu_meetod]:[päringu_uri]:[aegamp]:[nonce] HMAC sisend ntample: (kasutades salavõtmena 'algo')
GET:/api/settings/audio.page.vol:1601312252:49936
Looge HMAC parooli ja HMAC-i sisendstringiga, kasutades SHA-256:
HMAC väljund ntample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Standardne autentimine ilma kasuliku koormuseta, ntample:

 Põhiline autentimise taotlus

Seda autentimismeetodit tuleks kasutada ettevaatlikult, kuna see on tavameetodist vähem turvaline.

Volitus: põhi [base64]
Example:
Volitus: põhiline YWRtaW46YWxnbwo=
Põhiautentimine ntample:

KÄSUD

 RESTful API käsud

Allpool on nimekiri kõigist toetatud API käskudest.

Märkus
PUT-i päring muudab või loob püsiva ressursi, mis püsib taaskäivitamise järel, samas kui POST-päring juhib seadet ainult praeguse seansi jooksul.

Kirjeldus	meetod	URI	Kasulik koormus Parameetrid	Tagasi Example	Toode	FW
Otsi konkreetse parameetri väärtus.	SAADA	/api/settings/[võtmenimi] Nt/api/settings/audio.page.vol	Ei kehti	{"audio.page.vol": "-18dB"}	Kõik	> 3.3
Tagastab ümbritseva müra taseme, mõõdetuna detsibellides. Ümbritseva müra kompenseerimine peab olema lubatud vahekaardil Põhiseaded -> Funktsioonid.	SAADA	/api/info/audio.noise.level	Ei kehti	{"audio.noise.level": 72}	Kõlarid Kuva kõlarid	> 3.3
Eraldage relee sisendklemmi olek.	SAADA	/api/info/input.relay.status	Ei kehti	{"input.relay.status": "idle"} või {"input.relay.status": "active"}	Kõik releesisendiga tooted, välja arvatud 8063. Vaata allpool.	> 4.1
Eraldage sisendi 1 või sisendi 2 klemmide olek.	SAADA	/api/info/input.relay1.status või /api/info/input.relay2.status	Ei kehti	{"input.relay1.status": "idle"} või {"input.relay1.status": "active"}	8063	> 4.1
Toonide loendi hankimine files praegu installitud.	SAADA	/api/info/tonelist	Ei kehti	{"tonelist":["bell-na.wav","bell uk.wav","buzzer.wav",…]}	Kõik	> 5.0
Saate hankida seadme teabe, mis kuvatakse lehel Olek.	SAADA	/api/info/status	Ei kehti	Täielik teabe loend vahekaardil Olek.	Kõik	> 5.4

Hankige lehel Teave kuvatav tooteteave.	SAADA	/api/info/about	Ei kehti	Kogu teave on vahekaardil Teave.	Kõik	> 5.4
Aktiveerige strobo soovitud värvi ja mustri parameetritega.	POSTITA	/api/controls/strobe/start	muster: 0–15} värv1: {sinine, punane, merevaigukollane, roheline} värv2: {sinine, punane, merevaigukollane, roheline} ledlvl: {1–255} hoidmine: {tõene, vale}	Ei kehti	8128 (G2) 8138 8190S	> 3.3
Peatage strobo.	POSTITA	/api/controls/strobe/stop	Ei kehti	Ei kehti	8128 (G2) 8138 8190S	> 3.3
Esitage helin üks kord või korrake seda.	POSTITA	/api/controls/tone/start	tee: {tone} st. kellamäng.wav tsükkel: {true, false} või {0, 1} nt {"path":"chime.wav", "loop":true}	Ei kehti	Kõlarid 8301 8373 8028 (G2) 8201 8039	> 3.3
Peatage toon.	POSTITA	/api/controls/tone/stop	Ei kehti	Ei kehti	Kõlarid 8301 8373 8028 (G2) 8201 8039	> 3.3
Helistage telefonilaiendile eelsalvestatud sõnumiga.	POSTITA	/api/controls/call/start	{"extension":"2099", "toon":"gong.wav", "intervall":"0", "maxdur":"10"}	Ei kehti	Kõlarid 8301 8410 8420	> 3.3
Lõpetage kõne.	POSTITA	/api/controls/call/stop	Ei kehti	Ei kehti	Kõlarid 8301 8410 8420	> 3.3

Algatage ühesuunaline lehekõne. Seade võtab helivoo vastu sihtlaiendilt.	POSTITA	/api/controls/call/page	{"laiendus":" ”}	Ei kehti	Kõlarid 8410 8420	> 5.3.4
Taaskäivitage sihtotspunkt.	POSTITA	/api/controls/reboot	Ei kehti	Ei kehti	Kõik	> 3.3
Avage uks. "local" juhib kohalikku releed "netdc1" juhib kaugvõrgu uksekontrollerit (8063)	POSTITA	/api/controls/door/unlock	ukse ID: {local, netdc1} * Valikuline	Ei kehti	8039 8028 (G2) 8201 8063	> 3.3
Lukusta uks.	POSTITA	/api/controls/door/lock	ukse ID: {local, netdc1} * Valikuline	Ei kehti	8039 8028 (G2) 8201 8063	> 3.3
Lubage 24 V aux out relee.	POSTITA	api/controls/24v/enable	Ei kehti	Ei kehti	8063	> 5.0
Keela 24v aux out relee.	POSTITA	api/controls/24v/disable	Ei kehti	Ei kehti	8063	> 5.0
Luba väljundrelee.	POSTITA	/api/controls/relay/enable	Ei kehti	Ei kehti	8063	> 5.0
Keela väljundrelee.	POSTITA	/api/controls/relay/disable	Ei kehti	Ei kehti	8063	> 5.0
Kontrollige Algo püsivara serverist uusimat püsivara versiooni.	POSTITA	/api/controls/upgrade/check	Ei kehti	{“versioon”: “uuendatud”} või {"versioon": " ”}	Kõik	> 4.1
Kontrollige Algo püsivara serverist uusimat püsivara versiooni ja minge sellele versioonile üle.	POSTITA	/api/controls/upgrade/start	Ei kehti	{"status": "updated"} või {"staatus": "täiendamine ”, „url”: url>} või {"staatus": " ”}	Kõik	> 4.1
Kujutise või mustri kuvamine ekraanil.	POSTITA	/api/controls/screen/start	Vaata allpool	Ei kehti	8410 8420	> 5.3.4
Peatage ekraanimuster ja naaske vaikekuvale.	POSTITA	/api/controls/screen/stop	Ei kehti	Ei kehti	8410 8420	> 5.3.4

Taaskäivitage põhirakendus.	POSTITA	/api/controls/reload	Ei kehti	Ei kehti	Kõik	> 5.3.4
Alustage otsest helivoogu kuulamist. Konfigureerige pordi number, kuhu voog saadetakse.	POSTITA	/api/controls/rx/start	{"port": }	Ei kehti	Kõik	> 5.3.4
Lõpetage otsehelivoo kuulamine.	POSTITA	/api/controls/rx/stop	Ei kehti	Ei kehti	Kõik	> 5.3.4
Määrake multisaaterežiim.	PANGE	/api/state/mcast/update/	{"mode":"saatja", "aadress": , "port": , "type":"rtp"} või {"mode":"sender", "address": , "port": , "tüüp":"polü", "rühm":1} **Märkus**: kui enne seda käsku kasutatakse juhtnuppe/toone/start, kõlab helin vastavalt seadme praegustele seadistustele. web UI	Ei kehti	8301	> 5.0
Sisestage väärtus JSON-i kasuliku koormuse konkreetsele parameetrile.	PANGE	/api/settings	parameeter: {value} nt {"audio.page.vol": "-3dB"}	Ei kehti	8180 (G2) 8186 8190 8190S 8301 8373	> 3.3

 Lihtsa juhtliidese (SCI) käsud

Kõik SCI-käsud on GET-päringud ja neil on autentimiseks ühised parameetrid "usi" ja "admin".
Example:
HANGI http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Kirjeldus	URI	Täiendav Kasulik koormus Parameetrid	Tooted	FW
Avage uks. "local" juhib kohalikku releed "netdc1" juhib kaugvõrgu uksekontrollerit (8063)	/sci/controls/do või/unlock	ukse ID: {local, netdc1} * Valikuline	8039 8028 (G2) 8201 8063	> 3.3
Lukusta uks.	/sci/controls/do või/lock	ukse ID: {local, netdc1} * Valikuline	8039 8028 (G2) 8201 8063	> 3.3
Esitage helin üks kord või korrake seda.	/sci/controls/to ne/start	tee: {tone} st. kellamäng.wav tsükkel: {true, false} või {0, 1}	Kõik	> 3.3
Peatage toon.	/sci/controls/to ne/stop	Ei kehti	Kõik	> 3.3
Aktiveerige strobo soovitud värvi ja mustri parameetritega.	/sci/controls/strobe/start	muster: {0–15} värv1: {sinine, punane, merevaigukollane, roheline} värv2: {sinine, punane, merevaigukollane, roheline} ledlvl: {1–255} hoidja: {tõene, vale}	8128 (G2) 8138 8190S	> 3.3
Peatage strobo.	/sci/controls/strobe/stop	Ei kehti	8128 (G2) 8138 8190S	> 3.3

Dokumendid / Ressursid

	ALGO RESTful API [pdfKasutusjuhend AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [pdfKasutusjuhend AL061-GU-CP000API-230717, RESTful API, RESTful, API

Viited

• Kasutusjuhend