ALGO RUSTIGE API

Produkinligting: RUSvolle API-gids

Die Algo RESTful API stel gebruikers in staat om toegang te verkry, te manipuleer en aksies op Algo IP-eindpunte op hul netwerk deur HTTP/HTTPS-versoeke te aktiveer. Hierdie dokument verskaf 'n eenvormige en voorafbepaalde stel staatlose bedrywighede wat gebruik kan word om met Algo-toestelle te kommunikeer. Die API ondersteun HTTP/HTTPS GET-, POST- en PUT-versoeke met JSON-loonvragte.

Stawing

Daar is drie tipes stawings beskikbaar met die Algo RESTful API:

• Standaard-verifikasie (by verstek geaktiveer)
• Basiese stawing (opsioneel)
• Geen verifikasiemetode nie (nie aanbeveel nie; slegs vir toetsdoeleindes)

Produkgebruiksinstruksies: RUSTIGE API

Voorvereistes

Voordat jy die RESTful API aktiveer, maak seker dat die toestel 'n internetverbinding het om die vooraf-gekonfigureerde NTP-bedieners te bereik. As geen internetverbinding beskikbaar is nie, stel 'n plaaslike NTP-bediener op en voer sy IP-adres in.

Aktiveer die RESTful API

1. Meld aan by die toestel web koppelvlak en navigeer na die Admin-oortjie Gevorderde instellings.
2. Rollees af na die API-ondersteuningsafdeling en aktiveer die RESTful API.
3. Stel die verlangde wagwoord (verstek wagwoord: algo). Let daarop dat standaard-verifikasie by verstek geaktiveer is.

Aktiveer basiese stawing (opsioneel)

1. In die web koppelvlak, gaan na die Stelselonderhoud-oortjie en laai die konfigurasie af file.
2. Maak die opstelling oop file met enige teksredigeerder en voeg die volgende reël by: api.auth.basic = 1
3. Stoor en laai die gewysigde konfigurasie op file terug na die toestel met die Herstel-konfigurasie File kenmerk in die Stelselonderhoud-oortjie.

Aktiveer geen stawingmetode (opsioneel)

Om die geen-verifikasiemetode te aktiveer, laat die RESTful API Wagwoord veld leeg. Hierdie metode word nie aanbeveel nie en moet slegs vir toetsdoeleindes gebruik word, aangesien dit geen sekuriteit bied nie.

Aktiveer eenvoudige beheerkoppelvlak (opsioneel)

1. Op die web koppelvlak, gaan na die Stelselonderhoud-oortjie en laai die konfigurasie af file.
2. Maak die opstelling oop file gebruik 'n teksredigeerder en voeg twee reëls by. Verander die wagwoord na u verlangde wagwoord.
3. Admin.web.sci = 1
4. Sci.admin.pwd =
5. Stoor en laai die gewysigde konfigurasie op file terug na die toestel met die Herstel-konfigurasie File kenmerk in die Stelselonderhoud-oortjie.

Verifikasie Sampdie Kode

E-pos asseblief support@algosolutions.com as jy 'n standaard- of basiese verifikasie wil hê sampdie kode.
Vir bykomende ondersteuning, bel 604-454-3792 of e-pos support@algosolutions.com

Inligtingskennisgewings

Let wel
Nota dui nuttige opdaterings, inligting en instruksies aan wat gevolg moet word

Disclaimer

Daar word geglo dat die inligting in hierdie dokument in alle opsigte akkuraat is, maar word nie deur Algo gewaarborg nie. Die inligting is onderhewig aan verandering sonder kennisgewing en moet op geen manier vertolk word as 'n verbintenis deur Algo of enige van sy affiliasies of filiale nie. Algo en sy affiliasies en filiale aanvaar geen verantwoordelikheid vir enige foute of weglatings in hierdie dokument nie. Hersienings van hierdie dokument of nuwe uitgawes daarvan kan uitgereik word om sulke veranderinge in te sluit. Algo aanvaar geen aanspreeklikheid vir skade of eise wat voortspruit uit enige gebruik van hierdie handleiding of sulke produkte, sagteware, fermware en/of hardeware nie. Geen deel van hierdie dokument mag gereproduseer of versend word in enige vorm of op enige manier – elektronies of meganies – vir enige doel sonder skriftelike toestemming van Algo nie.
Vir bykomende inligting of tegniese bystand in Noord-Amerika, kontak asseblief Algo se ondersteuningspan:

Algo Tegniese Ondersteuning
1-604-454-3792
support@algosolutions.com

©2022 Algo is 'n geregistreerde handelsmerk van Algo Communication Products Ltd.
Alle regte voorbehou. Alle ander handelsmerke is die eiendom van hul onderskeie eienaars. Alle spesifikasies is onderhewig aan verandering sonder kennisgewing.

 ALGEMEEN

Inleiding

Hierdie dokument beskryf hoe Algo RESTful API gebruik kan word om toegang te verkry, te manipuleer en aksies op Algo IP-eindpunte op jou netwerk te aktiveer deur HTTP/HTTPS-versoeke, sowel as 'n paar verskillende verifikasiemetodes met verskillende vlakke van sekuriteit. Versoekstelsels kan met Algo-toestelle interaksie hê deur 'n eenvormige en voorafbepaalde stel staatlose bedrywighede wat in hierdie dokument gedefinieer word. Versoeke word gerig aan 'n hulpbron se URI met 'n JSON-loonvrag en ontlok 'n JSON-reaksie. HTTP/HTTPS GET-, POST- en PUT-versoeke word gemaak na hulpbron-URI saam met die JSON-loonvrag (sien opdragafdeling vir 'n lys van loonvragte).

 Stawing

Daar is drie tipes stawings:

•  Standaard (aanbeveel)
•  Basies
•  Geen (nie aanbeveel nie)

Die Standaard-verifikasie gebruik 'n Hash-gebaseerde Boodskapverifikasiekode (HMAC) met 'n SHA-256-gekodeerde samevatting. Basiese verifikasie gebruik Base64-kodering en moet slegs oor HTTPS gebruik word. Geen stawing moet slegs met uiterste sorg gebruik word nie, aangesien dit geen stawing verskaf nie. Sien die Verifikasievereistes-afdeling vir meer besonderhede.

OPSTEL EN KONFIGURASIE

Voorvereistes

•  Hierdie dokument neem aan dat die Algo-eindpunt fermwareweergawe 3.3 of hoër gebruik.
•  Die tydsverskil tussen die versoeker en die Algo-toestelle moet minder as 30 sekondes wees om standaardstawing te gebruik.
• Maak seker dat NTP (Network Time Protocol) in gebruik is. Die adresse van pasgemaakte NTP-bedieners kan in die Gevorderde instellings → Tyd-oortjie gekonfigureer word.

Let wel
Die vooraf gekonfigureerde NTP-bedieners word publiek gehuisves, daarom is internetverbinding nodig om dit te bereik. As geen internetverbinding beskikbaar is nie, stel 'n plaaslike NTP-bediener op en voer sy IP-adres in.

• Maak seker dat die Algo-toestelstelseltyd aangepas is na die korrekte tydsone. Dit kan gedoen word deur na die Gevorderde instellings → Tyd-oortjie te gaan.

 Aktiveer die RESTful API

1. Meld aan by die web koppelvlak en navigeer na die Gevorderde instellings → Admin-oortjie.
2. Blaai af na die API-ondersteuningsafdeling, aktiveer die RESTful API en stel die wagwoord soos verlang (standaard wagwoord: algo)
   Let wel
   Standaard-verifikasie is by verstek geaktiveer.

Aktiveer basiese stawing (opsioneel)

1. In die web koppelvlak, gaan na die Stelsel → Onderhoud-oortjie en laai die konfigurasie af file.
2. Maak die opstelling oop file met enige teksredigeerder en voeg die volgende reël by: api.auth.basic = 1
3.  Stoor en laai die gewysigde konfigurasie op file terug na die toestel met die Herstel-konfigurasie File kenmerk in die Stelsel → Onderhoud-oortjie.

Geen stawingmetode (opsioneel)

Om die geen-verifikasiemetode te aktiveer, laat die RESTful API Wagwoord veld leeg. Hierdie metode word nie aanbeveel nie en moet slegs vir toetsdoeleindes gebruik word, aangesien dit geen sekuriteit bied nie.

Aktiveer eenvoudige beheerkoppelvlak (opsioneel)

1. Op die web koppelvlak, gaan na die Stelsel → Onderhoud-oortjie en laai die konfigurasie af file.
2.  Maak die opstelling oop file gebruik 'n teksredigeerder en voeg twee reëls by. Verander die na jou verlangde wagwoord. Admin.web.sci = 1
   Sci.admin.pwd =
3.  Stoor en laai die gewysigde konfigurasie op file terug na die toestel met die Herstel-konfigurasie File kenmerk in die Stelsel → Onderhoud-oortjie.

STATINGSVEREISTES

E-pos asseblief support@algosolutions.com as jy 'n standaard- of basiese verifikasie wil hê sampdie kode.

Standaard-verifikasieversoek met 'n JSON-loonvrag

Vereiste opskrifte in HTTP/HTTPS-versoek
> Inhoud-tipe: "toepassing/json"
> Inhoud-MD5: [content_md5] Bvample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Magtiging: hmac admin:[nonce]:[hmac_output]
Die magtigingsopskrifte bestaan ​​uit:

1. Die string 'hmac admin' gevolg deur 'n dubbelpunt ':'.
2. Nonce – 'n Ewekansige of nie-herhalende waarde, gevolg deur 'n dubbelpunt ':'.
3. Hmac_output – gegenereer deur die RESTful API-wagwoord (geheime sleutel) wat op jou toestel opgestel is en die HMAC-invoer, soos hieronder aangedui:
   [request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[nie eens]

HMAC-invoer bvample: (gebruik 'algo' as die geheime sleutel)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Genereer HMAC met wagwoord en HMAC-invoerstring as digest met SHA-256:
HMAC uitset bvample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Datum: dag, datum maand, jaar hr:min:sek GMT
Example
Datum: Don, 22 Sept, 2022 02:33:07 GMT
Standaard verifikasie met loonvrag bvample:

 Standaard-verifikasieversoek sonder 'n JSON-loonvrag

Identies aan 3.1 met inhoudverwante opskrifte/hmac-invoer weggelaat.
HMAC-invoer: [request_method]:[request_uri]:[timestamp]:[nie eenkeer] HMAC-invoer bvample: (gebruik 'algo' as die geheime sleutel)
KRY:/api/settings/audio.page.vol:1601312252:49936
Genereer HMAC met wagwoord en HMAC-invoerstring met SHA-256:
HMAC uitset bvample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Standaard verifikasie sonder loonvrag bvample:

 Basiese stawingversoek

Hierdie metode van verifikasie moet versigtig gebruik word aangesien dit minder veilig is as die standaardmetode.

Magtiging: Basies [base64]
Example:
Magtiging: Basiese YWRtaW46YWxnbwo=
Basiese verifikasie bvample:

OPDRAGTE

 RUSTIGE API-opdragte

Hieronder is 'n lys van alle ondersteunde API-opdragte.

Let wel
'n PUT-versoek verander of skep 'n permanente hulpbron wat 'n herlaai oorleef, terwyl 'n POST-versoek slegs die toestel vir die huidige sessie beheer.

Beskrywing	Metode	URI	Loonvrag Parameters	Keer terug Example	Produk	FW
Haal die waarde van 'n spesifieke parameter op.	KRY	/api/settings/[sleutelnaam] Bv./api/settings/audio.page.vol	NVT	{“audio.page.vol”: “-18dB”}	Almal	> 3.3
Gee die omgewingsgeraasvlak, gemeet in desibel, terug. Omgewingsgeraaskompensasie moet in Basiese instellings -> Kenmerke-oortjie geaktiveer word.	KRY	/api/info/audio.noise.level	NVT	{“audio.noise.level”: 72}	Luidsprekers Vertoon Luidsprekers	> 3.3
Onttrek die status van die aflos-invoerterminal.	KRY	/api/info/input.relay.status	NVT	{“input.relay.status”: “idle”} of {“input.relay.status”: “aktief”}	Alle produkte met 'n aflos-invoer, behalwe die 8063. Sien hieronder.	> 4.1
Onttrek die status van Inset 1 of Inset 2 terminale.	KRY	/api/info/input.relay1.status of /api/info/input.relay2.status	NVT	{“input.relay1.status”: “idle”} of {“input.relay1.status”: “aktief”}	8063	> 4.1
Haal die lys van toon op files tans geïnstalleer.	KRY	/api/info/tonelist	NVT	{“tonelist”:[“bell-na.wav”,,”bell uk.wav”,,”buzzer.wav”,...]}	Almal	> 5.0
Haal die toestelinligting op wat op die Status-bladsy vertoon word.	KRY	/api/info/status	NVT	Volledige lys inligting vanaf die Status-oortjie.	Almal	> 5.4

Kry die produkinligting wat op die Meer oor-bladsy vertoon word.	KRY	/api/info/about	NVT	Alle inligting is op die Oor-oortjie beskikbaar.	Almal	> 5.4
Aktiveer die strobe met gewenste kleur- en patroonparameters.	POS	/api/kontroles/strobe/start	patroon: {0 – 15} kleur1: {blou, rooi, amber, groen} kleur2: {blou, rooi, amber, groen} ledlvl: {1 – 255} vashouplek: {waar, onwaar}	NVT	8128(G2) 8138 8190's	> 3.3
Stop die strobe.	POS	/api/kontroles/strobe/stop	NVT	NVT	8128(G2) 8138 8190's	> 3.3
Speel een keer 'n toon of lus dit.	POS	/api/kontroles/toon/begin	pad: {toon} dws. chime.wav lus: {true, false} of {0, 1} bv. {“pad”:”chime.wav”, “lus”:waar}	NVT	Luidsprekers 8301 8373 8028(G2) 8201 8039	> 3.3
Stop die toon.	POS	/api/kontroles/toon/stop	NVT	NVT	Luidsprekers 8301 8373 8028(G2) 8201 8039	> 3.3
Bel 'n telefoonuitbreiding met 'n vooraf opgeneemde boodskap.	POS	/api/kontroles/oproep/begin	{“extension”:”2099″, “toon”:”gong.wav”, “interval”:”0″, “maxdur”:”10″}	NVT	Luidsprekers 8301 8410 8420	> 3.3
Beëindig die oproep.	POS	/api/kontroles/bel/stop	NVT	NVT	Luidsprekers 8301 8410 8420	> 3.3

Begin 'n eenrigting-bladsy-oproep. Die toestel sal die klankstroom vanaf die teikenuitbreiding ontvang.	POS	/api/kontroles/oproep/bladsy	{“extension”:” ”}	NVT	Luidsprekers 8410 8420	> 5.3.4
Herlaai die teiken eindpunt.	POS	/api/kontroles/herlaai	NVT	NVT	Almal	> 3.3
Maak die deur oop. "plaaslik" beheer die plaaslike aflos "netdc1" beheer die afgeleë netwerk deurbeheerder (8063)	POS	/api/kontroles/deur/ontsluit	deurid: {plaaslik, netdc1} * Opsioneel	NVT	8039 8028(G2) 8201 8063	> 3.3
Sluit die deur.	POS	/api/kontroles/deur/slot	deurid: {plaaslik, netdc1} * Opsioneel	NVT	8039 8028(G2) 8201 8063	> 3.3
Aktiveer die 24v aux uit relay.	POS	api/kontroles/24v/aktiveer	NVT	NVT	8063	> 5.0
Deaktiveer die 24v aux uit relay.	POS	api/kontroles/24v/deaktiveer	NVT	NVT	8063	> 5.0
Aktiveer die uitsetaflos.	POS	/api/controls/relay/enable	NVT	NVT	8063	> 5.0
Deaktiveer die uitsetaflos.	POS	/api/kontroles/relay/deaktiveer	NVT	NVT	8063	> 5.0
Gaan Algo se firmware-bediener na vir die nuutste firmware-weergawe.	POS	/api/controls/upgrade/check	NVT	{“version”: “updated”} of {“version”: “ ”}	Almal	> 4.1
Gaan Algo se firmware-bediener na vir die nuutste firmwareweergawe en gradeer op na daardie weergawe.	POS	/api/controls/upgrade/start	NVT	{“status”: “opgedateer”} of {"status": "opgradering ”, “url”: url>} of {“status”: “ ”}	Almal	> 4.1
Vertoon 'n prent of patroon op die skerm.	POS	/api/kontroles/skerm/begin	Sien hieronder	NVT	8410 8420	> 5.3.4
Stop die skermpatroon en keer terug na die verstekskerm.	POS	/api/kontroles/skerm/stop	NVT	NVT	8410 8420	> 5.3.4

Herbegin die hooftoepassing.	POS	/api/kontroles/herlaai	NVT	NVT	Almal	> 5.3.4
Begin luister na 'n direkte oudiostroom. Stel die poortnommer op waarna die stroom gestuur word.	POS	/api/kontroles/rx/start	{“poort”: }	NVT	Almal	> 5.3.4
Hou op om na 'n direkte oudiostroom te luister.	POS	/api/kontroles/rx/stop	NVT	NVT	Almal	> 5.3.4
Stel die multicast-modus in.	PUT	/api/state/mcast/update/	{“mode”:”sender”, “address”: , "poort": , “type”:”rtp”} of {“mode”:”sender”, “address”: , "poort": , "tipe":"poly", "groep":1} **Let wel**: As kontroles/toon/begin voor hierdie opdrag gebruik word, sal die toon speel met huidige instellings op die web UI.	NVT	8301	> 5.0
Voeg 'n waarde by 'n spesifieke parameter vanaf JSON loonvrag.	PUT	/api/instellings	parameter: {waarde} bv. {“audio.page.vol”: “-3dB”}	NVT	8180(G2) 8186 8190 8190's 8301 8373	> 3.3

 Eenvoudige beheerkoppelvlak (SCI) opdragte

Alle SCI-opdragte is GET-versoeke en het die algemene parameters "usi" en "admin" vir verifikasie.
Example:
KRY http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Beskrywing	URI	Bykomende Loonvrag Parameters	Produkte	FW
Maak die deur oop. "plaaslik" beheer die plaaslike aflos "netdc1" beheer die afgeleë netwerk deurbeheerder (8063)	/sci/controls/do of/ontsluit	deurid: {plaaslik, netdc1} * Opsioneel	8039 8028(G2) 8201 8063	> 3.3
Sluit die deur.	/sci/controls/do of/lock	deurid: {plaaslik, netdc1} * Opsioneel	8039 8028(G2) 8201 8063	> 3.3
Speel een keer 'n toon of lus dit.	/sci/controls/to ne/start	pad: {toon} dws. chime.wav lus: {true, false} of {0, 1}	Almal	> 3.3
Stop die toon.	/sci/controls/to ne/stop	NVT	Almal	> 3.3
Aktiveer die strobe met gewenste kleur- en patroonparameters.	/sci/controls/strobe/start	patroon: {0 – 15} kleur1: {blou, rooi, amber, groen} kleur2: {blou, rooi, amber, groen} ledlvl: {1 – 255} vashouplek: {true, valse}	8128(G2) 8138 8190's	> 3.3
Stop die strobe.	/sci/kontroles/strobe/stop	NVT	8128(G2) 8138 8190's	> 3.3

Dokumente / Hulpbronne

	ALGO RUSTIGE API [pdf] Gebruikersgids AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RUSTIGE API [pdf] Gebruikersgids AL061-GU-CP000API-230717, RESTful API, RESTful, API

Verwysings

• Gebruikershandleiding