ALGO RESTful API

Informācija par produktu: RESTful API rokasgrāmata

Algo RESTful API ļauj lietotājiem piekļūt, manipulēt un aktivizēt darbības Algo IP galapunktos savā tīklā, izmantojot HTTP/HTTPS pieprasījumus. Šis dokuments nodrošina vienotu un iepriekš definētu bezvalsts darbību kopu, ko var izmantot, lai mijiedarbotos ar Algo ierīcēm. API atbalsta HTTP/HTTPS GET, POST un PUT pieprasījumus ar JSON lietderīgajām slodzēm.

Autentifikācija

Ar Algo RESTful API ir pieejami trīs autentifikācijas veidi:

• Standarta autentifikācija (iespējota pēc noklusējuma)
• Pamata autentifikācija (pēc izvēles)
• Nav autentifikācijas metodes (nav ieteicams; tikai testēšanas nolūkiem)

Produkta lietošanas instrukcijas: RESTful API

Priekšnoteikumi

Pirms RESTful API iespējošanas pārliecinieties, vai ierīcei ir interneta savienojums, lai sasniegtu iepriekš konfigurētos NTP serverus. Ja interneta savienojums nav pieejams, konfigurējiet vietējo NTP serveri un ievadiet tā IP adresi.

RESTful API iespējošana

1. Piesakieties ierīcē web saskarni un dodieties uz cilni Advanced Settings Administrēšana.
2. Ritiniet uz leju līdz sadaļai API atbalsts un iespējojiet RESTful API.
3. Iestatiet vēlamo paroli (noklusējuma parole: algo). Ņemiet vērā, ka standarta autentifikācija ir iespējota pēc noklusējuma.

Pamata autentifikācijas iespējošana (neobligāti)

1. In web saskarni, dodieties uz cilni Sistēmas uzturēšana un lejupielādējiet konfigurāciju file.
2. Atveriet konfigurāciju file ar jebkuru teksta redaktoru un pievienojiet šādu rindiņu: api.auth.basic = 1
3. Saglabājiet un augšupielādējiet modificēto konfigurāciju file atpakaļ uz ierīci, izmantojot Atjaunot konfigurāciju File funkciju cilnē Sistēmas uzturēšana.

Autentifikācijas metodes neiespējošana (neobligāti)

Lai iespējotu bezautentifikācijas metodi, atstājiet lauku RESTful API Password tukšu. Šī metode nav ieteicama, un to vajadzētu izmantot tikai testēšanas nolūkos, jo tā nenodrošina drošību.

Vienkāršas vadības interfeisa iespējošana (pēc izvēles)

1. Uz web saskarni, dodieties uz cilni Sistēmas uzturēšana un lejupielādējiet konfigurāciju file.
2. Atveriet konfigurāciju file izmantojot teksta redaktoru un pievienojiet divas rindiņas. Mainiet paroli uz vēlamo.
3. Administratorsweb.sci = 1
4. Sci.admin.pwd =
5. Saglabājiet un augšupielādējiet modificēto konfigurāciju file atpakaļ uz ierīci, izmantojot Atjaunot konfigurāciju File funkciju cilnē Sistēmas uzturēšana.

Autentifikācija Sample Kods

Lūdzu, e-pastu support@algosolutions.com ja vēlaties standarta vai pamata autentifikāciju sampkodu.
Lai saņemtu papildu atbalstu, zvaniet 604-454-3792 vai e-pastu support@algosolutions.com

Informācijas paziņojumi

Piezīme
Piezīme norāda noderīgus atjauninājumus, informāciju un norādījumus, kas jāievēro

Atruna

Tiek uzskatīts, ka šajā dokumentā ietvertā informācija visos aspektos ir precīza, taču Algo to negarantē. Informācija var tikt mainīta bez iepriekšēja brīdinājuma, un tā nekādā veidā nav jāuztver kā Algo vai kāda tā filiāles vai meitasuzņēmuma saistības. Algo un tā saistītie uzņēmumi un meitasuzņēmumi neuzņemas nekādu atbildību par kļūdām vai izlaidumiem šajā dokumentā. Lai iekļautu šādas izmaiņas, var izdot šī dokumenta labojumus vai jaunus tā izdevumus. Algo neuzņemas nekādu atbildību par zaudējumiem vai pretenzijām, kas izriet no jebkādas šīs rokasgrāmatas vai šādu produktu, programmatūras, programmaparatūras un/vai aparatūras lietošanas. Nevienu šī dokumenta daļu nedrīkst reproducēt vai pārsūtīt nekādā veidā vai ar jebkādiem līdzekļiem – elektroniski vai mehāniski – nekādiem nolūkiem bez Algo rakstiskas atļaujas.
Lai iegūtu papildinformāciju vai tehnisko palīdzību Ziemeļamerikā, lūdzu, sazinieties ar Algo atbalsta komandu:

Algo tehniskais atbalsts
1-604-454-3792
support@algosolutions.com

©2022 Algo ir Algo Communication Products Ltd reģistrēta preču zīme.
Visas tiesības aizsargātas. Visas pārējās preču zīmes ir to attiecīgo īpašnieku īpašums. Visas specifikācijas var tikt mainītas bez brīdinājuma.

 VISPĀRĪGI

Ievads

Šajā dokumentā ir aprakstīts, kā Algo RESTful API var izmantot, lai piekļūtu, manipulētu un aktivizētu darbības Algo IP galapunktos jūsu tīklā, izmantojot HTTP/HTTPS pieprasījumus, kā arī dažas dažādas autentifikācijas metodes ar dažādiem drošības līmeņiem. Pieprasīšanas sistēmas var mijiedarboties ar Algo ierīcēm, izmantojot vienotu un iepriekš noteiktu bezvalstnieku darbību kopu, kas definēta šajā dokumentā. Pieprasījumi tiek nosūtīti uz resursa URI ar JSON lietderīgo slodzi un izsauc JSON atbildi. HTTP/HTTPS GET, POST un PUT pieprasījumi tiek veikti, lai resursu URI kopā ar JSON lietderīgo slodzi (derīgo kravu sarakstu skatiet komandu sadaļā).

 Autentifikācija

Ir trīs autentifikācijas veidi:

•  Standarta (ieteicams)
•  Pamata
•  Nav (nav ieteicams)

Standarta autentifikācijai tiek izmantots uz jaucējkods balstīts ziņojuma autentifikācijas kods (HMAC) ar SHA-256 kodētu īssavilkumu. Pamata autentifikācija izmanto Base64 kodējumu, un to vajadzētu izmantot tikai HTTPS. Nekādu autentifikāciju nevajadzētu izmantot tikai ļoti uzmanīgi, jo tā nenodrošina autentifikāciju. Plašāku informāciju skatiet sadaļā Autentifikācijas prasības.

IESTATĪŠANA UN KONFIGURĀCIJA

Priekšnoteikumi

•  Šajā dokumentā tiek pieņemts, ka Algo galapunktā darbojas programmaparatūras versija 3.3 vai jaunāka.
•  Lai izmantotu standarta autentifikāciju, laika starpībai starp pieprasītāju un Algo ierīcēm jābūt mazākai par 30 sekundēm.
• Pārliecinieties, vai tiek izmantots NTP (Network Time Protocol). Pielāgotu NTP serveru adreses var konfigurēt cilnē Papildu iestatījumi → Laiks.

Piezīme
Iepriekš konfigurētie NTP serveri ir publiski mitināti, tāpēc, lai tos sasniegtu, ir nepieciešams interneta savienojums. Ja interneta savienojums nav pieejams, konfigurējiet vietējo NTP serveri un ievadiet tā IP adresi.

• Pārliecinieties, vai Algo ierīces sistēmas laiks ir pielāgots pareizajai laika joslai. To var izdarīt, dodoties uz cilni Papildu iestatījumi → Laiks.

 RESTful API iespējošana

1. Piesakieties web saskarni un dodieties uz cilni Papildu iestatījumi → Administrēšana.
2. Ritiniet uz leju līdz sadaļai API atbalsts, iespējojiet RESTful API un iestatiet vēlamo paroli (noklusējuma parole: algo)
   Piezīme
   Standarta autentifikācija ir iespējota pēc noklusējuma.

Iespējot pamata autentifikāciju (neobligāti)

1. In web saskarni, dodieties uz cilni Sistēma → Apkope un lejupielādējiet konfigurāciju file.
2. Atveriet konfigurāciju file ar jebkuru teksta redaktoru un pievienojiet šādu rindiņu: api.auth.basic = 1
3.  Saglabājiet un augšupielādējiet modificēto konfigurāciju file atpakaļ uz ierīci, izmantojot Atjaunot konfigurāciju File funkciju cilnē Sistēma → Apkope.

Nav autentifikācijas metodes (neobligāti)

Lai iespējotu bezautentifikācijas metodi, atstājiet lauku RESTful API Password tukšu. Šī metode nav ieteicama, un to vajadzētu izmantot tikai testēšanas nolūkos, jo tā nenodrošina drošību.

Vienkāršas vadības interfeisa iespējošana (pēc izvēles)

1. Uz web saskarni, dodieties uz cilni Sistēma → Apkope un lejupielādējiet konfigurāciju file.
2.  Atveriet konfigurāciju file izmantojot teksta redaktoru un pievienojiet divas rindiņas. Nomaini pēc jūsu vēlmes paroles. Administratorsweb.sci = 1
   Sci.admin.pwd =
3.  Saglabājiet un augšupielādējiet modificēto konfigurāciju file atpakaļ uz ierīci, izmantojot Atjaunot konfigurāciju File funkciju cilnē Sistēma → Apkope.

AUTENTIKĀCIJAS PRASĪBAS

Lūdzu, e-pastu support@algosolutions.com ja vēlaties standarta vai pamata autentifikāciju sampkodu.

Standarta autentifikācijas pieprasījums ar JSON lietderīgo slodzi

Nepieciešamās galvenes HTTP/HTTPS pieprasījumā
> Satura veids: “application/json”
> Content-MD5: [content_md5] Piemample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Autorizācija: hmac admin:[nonce]:[hmac_output]
Autorizācijas galvenes sastāv no:

1. Virkne "hmac admin", kam seko kols ":".
2. Nonce — nejauša vai neatkārtojama vērtība, kam seko kols ':'.
3. Hmac_output — ģenerē RESTful API parole (slepenā atslēga), kas konfigurēta jūsu ierīcē, un HMAC ievade, kā norādīts tālāk:
   [pieprasījuma_metode]:[pieprasījuma_uri]:[satura_md5]:[satura_veids]:[laiksamp]:[nonce]

HMAC ieeja, piemample: (izmantojot "algo" kā slepeno atslēgu)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Ģenerējiet HMAC ar paroli un HMAC ievades virkni kā īssavilkumu, izmantojot SHA-256:
HMAC izvade, piemample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Datums: diena, datums mēnesis, gads h:min:sek GMT
Example
Datums: Ceturtdiena, 22. gada 2022. septembris, 02:33:07 GMT
Standarta autentifikācija ar lietderīgo slodzi, piemample:

 Standarta autentifikācijas pieprasījums bez JSON slodzes

Identisks 3.1, ar saturu saistītās galvenes/hmac ievade ir izlaista.
HMAC ievade: [request_method]:[request_uri]:[timestamp]:[nonce] HMAC ievade, piemample: (izmantojot "algo" kā slepeno atslēgu)
GET:/api/settings/audio.page.vol:1601312252:49936
Ģenerējiet HMAC ar paroli un HMAC ievades virkni, izmantojot SHA-256:
HMAC izvade, piemample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Standarta autentifikācija bez kravas, piemēram,ample:

 Pamata autentifikācijas pieprasījums

Šī autentifikācijas metode ir jāizmanto uzmanīgi, jo tā ir mazāk droša nekā standarta metode.

Autorizācija: pamata [base64]
Example:
Autorizācija: pamata YWRtaW46YWxnbwo=
Pamata autentifikācija, piemēram,ample:

KOMANDAS

 RESTful API komandas

Zemāk ir visu atbalstīto API komandu saraksts.

Piezīme
PUT pieprasījums maina vai izveido pastāvīgu resursu, kas izdzīvo pēc atsāknēšanas, savukārt POST pieprasījums kontrolē ierīci tikai pašreizējā sesijā.

Apraksts	Metode	URI	Lietderīgā slodze Parametri	Atgriezties Example	Produkts	FW
Izgūstiet noteikta parametra vērtību.	IEGŪT	/api/settings/[atslēgas nosaukums] Piem./api/settings/audio.page.vol	N/A	{“audio.page.vol”: “-18dB”}	Visi	> 3.3
Atgriež apkārtējā trokšņa līmeni decibelos. Apkārtējā trokšņa kompensācija ir jāiespējo cilnē Pamatiestatījumi -> Funkcijas.	IEGŪT	/api/info/audio.noise.level	N/A	{“audio.noise.level”: 72}	Skaļruņi Displeja skaļruņi	> 3.3
Izņemiet releja ievades termināļa statusu.	IEGŪT	/api/info/input.relay.status	N/A	{"input.relay.status": "idle"} vai {"input.relay.status": "active"}	Visi produkti ar releja ieeju, izņemot 8063. Skatiet tālāk.	> 4.1
Izņemiet 1. vai 2. ieejas spaiļu statusu.	IEGŪT	/api/info/input.relay1.status vai /api/info/input.relay2.status	N/A	{"input.relay1.status": "idle"} vai {"input.relay1.status": "active"}	8063	> 4.1
Izgūt toņu sarakstu files pašlaik ir instalēts.	IEGŪT	/api/info/tonelist	N/A	{“tonelists”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Visi	> 5.0
Izgūstiet informāciju par ierīci, kas tiek parādīta lapā Statuss.	IEGŪT	/api/info/status	N/A	Pilns informācijas saraksts no cilnes Statuss.	Visi	> 5.4

Izgūstiet informāciju par produktu, kas tiek parādīta lapā Par.	IEGŪT	/api/info/about	N/A	Visa informācija ir pieejama cilnē Par.	Visi	> 5.4
Aktivizējiet stroboskopu ar vēlamo krāsu un raksta parametriem.	POSTĪT	/api/controls/strobe/start	modelis: {0–15} krāsa1: {zils, sarkans, dzintars, zaļš} krāsa2: {zils, sarkans, dzintars, zaļš} ledlvl: {1–255} aizturēšana: {true, false}	N/A	8128(G2) 8138 8190S	> 3.3
Apturiet stroboskopu.	POSTĪT	/api/controls/strobe/stop	N/A	N/A	8128(G2) 8138 8190S	> 3.3
Vienreiz atskaņojiet signālu vai atkārtojiet to.	POSTĪT	/api/controls/tone/start	ceļš: {tone}, ti. zvans.wav cilpa: {true, false} vai {0, 1} piem., {"path":"chime.wav", "cilpa":true}	N/A	Skaļruņi 8301 8373 8028(G2) 8201 8039	> 3.3
Pārtrauciet toni.	POSTĪT	/api/controls/tone/stop	N/A	N/A	Skaļruņi 8301 8373 8028(G2) 8201 8039	> 3.3
Zvaniet uz tālruņa paplašinājumu ar iepriekš ierakstītu ziņojumu.	POSTĪT	/api/controls/call/start	{“paplašinājums”:”2099”, "tone":"gong.wav", "interval":"0", "maxdur":"10"}	N/A	Skaļruņi 8301 8410 8420	> 3.3
Beigt zvanu.	POSTĪT	/api/controls/call/stop	N/A	N/A	Skaļruņi 8301 8410 8420	> 3.3

Sāciet vienvirziena lapas zvanu. Ierīce saņems audio straumi no mērķa paplašinājuma.	POSTĪT	/api/controls/call/page	{“paplašinājums”:” ”}	N/A	Skaļruņi 8410 8420	> 5.3.4
Atsāknējiet mērķa galapunktu.	POSTĪT	/api/controls/reboot	N/A	N/A	Visi	> 3.3
Atslēdziet durvis. “local” kontrolē vietējo releju “netdc1” kontrolē attālo tīkla durvju kontrolleri (8063)	POSTĪT	/api/controls/door/unlock	durvju ID: {local, netdc1} *Neobligāti	N/A	8039 8028(G2) 8201 8063	> 3.3
Aizslēdz durvis.	POSTĪT	/api/controls/door/lock	durvju ID: {local, netdc1} *Neobligāti	N/A	8039 8028(G2) 8201 8063	> 3.3
Iespējojiet 24 V papildu izejas releju.	POSTĪT	api/controls/24v/enable	N/A	N/A	8063	> 5.0
Atspējojiet 24 V papildu izejas releju.	POSTĪT	api/controls/24v/disable	N/A	N/A	8063	> 5.0
Iespējot izejas releju.	POSTĪT	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
Atspējojiet izejas releju.	POSTĪT	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
Jaunāko programmaparatūras versiju pārbaudiet Algo programmaparatūras serverī.	POSTĪT	/api/controls/upgrade/check	N/A	{“versija”: “atjaunināta”} vai {“versija”: “ ”}	Visi	> 4.1
Pārbaudiet Algo programmaparatūras serverī jaunāko programmaparatūras versiju un jauniniet uz šo versiju.	POSTĪT	/api/controls/upgrade/start	N/A	{“statuss”: “atjaunināts”} vai {"statuss": "jaunināšana ”, “url”: url>} vai {"statuss": " ”}	Visi	> 4.1
Parādiet ekrānā attēlu vai rakstu.	POSTĪT	/api/controls/screen/start	Skat zemāk	N/A	8410 8420	> 5.3.4
Apturiet ekrāna zīmējumu un atgriezieties noklusējuma ekrānā.	POSTĪT	/api/controls/screen/stop	N/A	N/A	8410 8420	> 5.3.4

Restartējiet galveno lietojumprogrammu.	POSTĪT	/api/controls/reload	N/A	N/A	Visi	> 5.3.4
Sāciet klausīties tiešo audio straumi. Konfigurējiet porta numuru, uz kuru tiek sūtīta straume.	POSTĪT	/api/controls/rx/start	{“ports”: }	N/A	Visi	> 5.3.4
Pārtrauciet klausīties tiešo audio straumi.	POSTĪT	/api/controls/rx/stop	N/A	N/A	Visi	> 5.3.4
Iestatiet multiraides režīmu.	PUT	/api/state/mcast/update/	{"režīms":"sūtītājs", "adrese": , “ports”: , "type":"rtp"} vai {"mode":"sender", "address": , “ports”: , “tips”:”poli”, “grupa”:1} **Piezīme**: ja pirms šīs komandas tiek izmantotas vadīklas/tonis/sākt, signāls tiks atskaņots, izmantojot pašreizējos iestatījumus web Lietotāja interfeiss	N/A	8301	> 5.0
Ievietojiet vērtību konkrētam parametram no JSON lietderīgās slodzes.	PUT	/api/settings	parametrs: {value} piemēram, {"audio.page.vol": "-3dB"}	N/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Vienkāršās vadības interfeisa (SCI) komandas

Visas SCI komandas ir GET pieprasījumi, un tām ir kopīgi parametri “usi” un “admin” autentifikācijai.
Example:
IEGŪT http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Apraksts	URI	Papildu Lietderīgā slodze Parametri	Produkti	FW
Atslēdziet durvis. “local” kontrolē vietējo releju “netdc1” kontrolē attālo tīkla durvju kontrolleri (8063)	/sci/controls/do vai/unlock	durvju ID: {local, netdc1} *Neobligāti	8039 8028(G2) 8201 8063	> 3.3
Aizslēdz durvis.	/sci/controls/do vai/lock	durvju ID: {local, netdc1} *Neobligāti	8039 8028(G2) 8201 8063	> 3.3
Vienreiz atskaņojiet signālu vai atkārtojiet to.	/sci/controls/to ne/start	ceļš: {tone}, ti. zvans.wav cilpa: {true, false} vai {0, 1}	Visi	> 3.3
Pārtrauciet toni.	/sci/controls/to ne/stop	N/A	Visi	> 3.3
Aktivizējiet stroboskopu ar vēlamo krāsu un raksta parametriem.	/sci/controls/strobe/start	raksts: {0–15} 1. krāsa: {zils, sarkans, dzintars, zaļš} krāsa2: {zils, sarkans, dzintars, zaļš} ledlvl: {1–255} aizturēšana: {true, false}	8128(G2) 8138 8190S	> 3.3
Apturiet stroboskopu.	/sci/controls/strobe/stop	N/A	8128(G2) 8138 8190S	> 3.3

Dokumenti / Resursi

	ALGO RESTful API [pdfLietotāja rokasgrāmata AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [pdfLietotāja rokasgrāmata AL061-GU-CP000API-230717, RESTful API, RESTful, API

Atsauces

• Lietotāja rokasgrāmata