ALGO RESTful API
Өнім туралы ақпарат: RESTful API нұсқаулығы
Algo RESTful API пайдаланушыларға HTTP/HTTPS сұраулары арқылы желідегі Algo IP соңғы нүктелеріндегі әрекеттерге қол жеткізуге, өңдеуге және іске қосуға мүмкіндік береді. Бұл құжат Algo құрылғыларымен әрекеттесу үшін пайдаланылуы мүмкін азаматтығы жоқ операциялардың біркелкі және алдын ала анықталған жинағын қамтамасыз етеді. API JSON пайдалы жүктемелері бар HTTP/HTTPS GET, POST және PUT сұрауларына қолдау көрсетеді.
Аутентификация
Algo RESTful API көмегімен аутентификацияның үш түрі бар:
- Стандартты аутентификация (әдепкі бойынша қосылған)
- Негізгі аутентификация (міндетті емес)
- Аутентификация әдісі жоқ (ұсынылмайды; тек сынақ мақсатында)
Өнімді пайдалану нұсқаулары: RESTful API
Алғы шарттар
RESTful API қосу алдында алдын ала конфигурацияланған NTP серверлеріне қол жеткізу үшін құрылғыда интернет байланысы бар екеніне көз жеткізіңіз. Интернет байланысы болмаса, жергілікті NTP серверін конфигурациялаңыз және оның IP мекенжайын енгізіңіз.
RESTful API қосу
- Құрылғыға кіріңіз web интерфейсін таңдап, «Қосымша параметрлер әкімшісі» қойындысына өтіңіз.
- API қолдау бөліміне төмен жылжып, RESTful API қосыңыз.
- Қажетті құпия сөзді орнатыңыз (әдепкі құпия сөз: algo). Стандартты аутентификация әдепкі бойынша қосылғанын ескеріңіз.
Негізгі аутентификацияны қосу (қосымша)
- жылы web интерфейсінде Жүйеге техникалық қызмет көрсету қойындысына өтіп, конфигурацияны жүктеп алыңыз file.
- Конфигурацияны ашыңыз file кез келген мәтіндік редактормен және келесі жолды қосыңыз: api.auth.basic = 1
- Өзгертілген конфигурацияны сақтаңыз және жүктеңіз file Конфигурацияны қалпына келтіру арқылы құрылғыға оралыңыз File Жүйеге техникалық қызмет көрсету қойындысындағы мүмкіндік.
Аутентификация әдісін қосу (қосымша)
Аутентификация жоқ әдісін қосу үшін RESTful API Password өрісін бос қалдырыңыз. Бұл әдіс ұсынылмайды және тек сынақ мақсатында ғана пайдаланылуы керек, өйткені ол қауіпсіздікті қамтамасыз етпейді.
Қарапайым басқару интерфейсін қосу (қосымша)
- бойынша web интерфейсінде Жүйеге техникалық қызмет көрсету қойындысына өтіп, конфигурацияны жүктеп алыңыз file.
- Конфигурацияны ашыңыз file мәтіндік редакторды пайдаланып, екі жолды қосыңыз. Өз қалауыңыз бойынша құпия сөзді өзгертіңіз.
- Админ.web.sci = 1
- Sci.admin.pwd =
- Өзгертілген конфигурацияны сақтаңыз және жүктеңіз file Конфигурацияны қалпына келтіру арқылы құрылғыға оралыңыз File Жүйеге техникалық қызмет көрсету қойындысындағы мүмкіндік.
Аутентификация Сampл коды
Электрондық поштаны жіберіңіз support@algosolutions.com стандартты немесе негізгі аутентификацияны қаласаңызampкоды.
Қосымша қолдау алу үшін қоңырау шалыңыз 604-454-3792 немесе электрондық пошта 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 протоколын HTTP/HTTPS сұраулары арқылы желіңіздегі Algo IP соңғы нүктелеріндегі әрекеттерге қол жеткізу, өңдеу және іске қосу үшін, сондай-ақ қауіпсіздік деңгейі әртүрлі бірнеше аутентификация әдістерін сипаттайды. Сұрау салу жүйелері Algo құрылғыларымен осы құжатта анықталған азаматтығы жоқ операциялардың біркелкі және алдын ала анықталған жиынтығы арқылы өзара әрекеттесе алады. Сұраулар JSON пайдалы жүктемесі бар ресурстың URI мекенжайына жасалады және JSON жауабын береді. HTTP/HTTPS GET, POST және PUT сұраулары JSON пайдалы жүктемесімен бірге URI ресурсына жасалады (пайдалы жүктемелер тізімін пәрмендер бөлімін қараңыз).
Аутентификация
Аутентификацияның үш түрі бар:
- Стандартты (ұсынылады)
- Негізгі
- Ешбір (ұсынылмайды)
Стандартты аутентификация SHA-256 кодталған дайджесті бар хэш негізіндегі хабардың аутентификация кодын (HMAC) пайдаланады. Негізгі аутентификация Base64 кодтауын пайдаланады және тек HTTPS арқылы пайдаланылуы керек. Ешбір аутентификацияны аса сақтықпен ғана қолдануға болмайды, себебі ол аутентификацияны қамтамасыз етпейді. Қосымша мәліметтер алу үшін Аутентификация талаптары бөлімін қараңыз.
ОРНАТУ ЖӘНЕ КОНФИГУРАЦИЯ
Алғы шарттар
- Бұл құжат Algo соңғы нүктесі микробағдарламаның 3.3 немесе одан жоғары нұсқасымен жұмыс істейді деп болжайды.
- Стандартты аутентификацияны пайдалану үшін сұраушы мен Algo құрылғылары арасындағы уақыт айырмашылығы 30 секундтан аз болуы керек.
- NTP (Network Time Protocol) пайдалануда екеніне көз жеткізіңіз. Пайдаланушы NTP серверлерінің мекенжайлары Кеңейтілген параметрлер → Уақыт қойындысында конфигурациялануы мүмкін.
Ескерту
Алдын ала конфигурацияланған NTP серверлері жалпыға қолжетімді, сондықтан оған жету үшін интернет байланысы қажет. Интернет байланысы болмаса, жергілікті NTP серверін конфигурациялаңыз және оның IP мекенжайын енгізіңіз.
- Algo құрылғысының жүйе уақыты дұрыс уақыт белдеуіне реттелгеніне көз жеткізіңіз. Мұны Қосымша параметрлер → Уақыт қойындысына өту арқылы жасауға болады.
RESTful API қосу
- жүйесіне кіріңіз web интерфейсін таңдап, Қосымша параметрлер → Әкімші қойындысына өтіңіз.
- API қолдау бөліміне төмен жылжыңыз, RESTful API қосыңыз және құпия сөзді қалағаныңызша орнатыңыз (әдепкі құпия сөз: algo)
Ескерту
Стандартты аутентификация әдепкі бойынша қосылады.
Негізгі аутентификацияны қосу (қосымша)
- жылы web интерфейсінде Жүйе → Техникалық қызмет көрсету қойындысына өтіп, конфигурацияны жүктеп алыңыз file.
- Конфигурацияны ашыңыз file кез келген мәтіндік редактормен және келесі жолды қосыңыз: api.auth.basic = 1
- Өзгертілген конфигурацияны сақтаңыз және жүктеңіз file Конфигурацияны қалпына келтіру арқылы құрылғыға оралыңыз File Жүйе → Техникалық қызмет көрсету қойындысындағы мүмкіндік.
Аутентификация әдісі жоқ (қосымша)
Аутентификация жоқ әдісін қосу үшін RESTful API Password өрісін бос қалдырыңыз. Бұл әдіс ұсынылмайды және тек сынақ мақсатында ғана пайдаланылуы керек, өйткені ол қауіпсіздікті қамтамасыз етпейді.
Қарапайым басқару интерфейсін қосу (қосымша)
- бойынша web интерфейсінде Жүйе → Техникалық қызмет көрсету қойындысына өтіп, конфигурацияны жүктеп алыңыз file.
- Конфигурацияны ашыңыз file мәтіндік редакторды пайдаланып, екі жолды қосыңыз. өзгертіңіз қалаған парольге. Админ.web.sci = 1
Sci.admin.pwd = - Өзгертілген конфигурацияны сақтаңыз және жүктеңіз file Конфигурацияны қалпына келтіру арқылы құрылғыға оралыңыз File Жүйе → Техникалық қызмет көрсету қойындысындағы мүмкіндік.
АВТЕНТАЦИЯЛЫҚ ТАЛАПТАР
Электрондық поштаны жіберіңіз support@algosolutions.com стандартты немесе негізгі аутентификацияны қаласаңызampкоды.
JSON пайдалы жүктемесі бар стандартты аутентификация сұрауы
HTTP/HTTPS сұрауында қажетті тақырыптар
> Мазмұн түрі: «application/json»
> Content-MD5: [content_md5] Мысалыample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b
Авторизация: hmac admin:[nonce]:[hmac_output]
Рұқсат ету тақырыптары мыналардан тұрады:
- 'hmac admin' жолы, одан кейін қос нүкте ':'.
- Nonce – Кездейсоқ немесе қайталанбайтын мән, одан кейін қос нүкте ':'.
- Hmac_output – құрылғыңызда конфигурацияланған RESTful API құпия сөзі (құпия кілт) және төменде көрсетілгендей HMAC кірісі арқылы жасалған:
[сұраныс_әдісі]:[сұрау_uri]:[content_md5]:[мазмұн_түрі]:[уақытamp]:[бір рет емес]
HMAC кірісі, мысалыample: (құпия кілт ретінде «algo» пайдалану)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 SHA-256 көмегімен дайджест ретінде құпия сөзбен және HMAC енгізу жолымен HMAC жасаңыз:
HMAC шығысы, мысалыample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330
Күн: күн, күн ай, жыл сағ:мин:сек GMT
Example
Күні: бейсенбі, 22 қыркүйек, 2022 жыл 02:33:07 GMT
Пайдалы жүктемемен стандартты аутентификация, мысалыampле:
JSON жүктемесі жоқ стандартты аутентификация сұрауы
Мазмұнға қатысты тақырыптар/hmac енгізуі жоқ 3.1 нұсқасымен бірдей.
HMAC кірісі: [сұрау_әдісі]:[сұрау_uri]:[уақытamp]:[бір рет емес] HMAC кірісі, мысалыample: (құпия кілт ретінде «algo» пайдалану)
GET:/api/settings/audio.page.vol:1601312252:49936
SHA-256 арқылы құпия сөзбен және HMAC енгізу жолымен HMAC жасаңыз:
HMAC шығысы, мысалыample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Пайдалы жүктемесіз стандартты аутентификация, мысалыampле:
Негізгі аутентификация сұрауы
Аутентификацияның бұл әдісін абайлап пайдалану керек, себебі ол стандартты әдіске қарағанда қауіпсіз емес.
Авторизация: Негізгі [base64]
Exampле:
Авторизация: Негізгі YWRtaW46YWxnbwo=
Негізгі аутентификация, мысалыampле:
ПАРМАНДАР
RESTful API пәрмендері
Төменде барлық қолдау көрсетілетін API пәрмендерінің тізімі берілген.
Ескерту
PUT сұрауы қайта жүктеуден аман қалатын тұрақты ресурсты өзгертеді немесе жасайды, ал POST сұрауы тек ағымдағы сеанс үшін құрылғыны басқарады.
| Сипаттама | Әдіс | URI | Пайдалы жүк Параметрлер | Қайту Example | Өнім | FW |
| Белгілі бір параметрдің мәнін шығарып алыңыз. | АЛУ | /api/settings/[кілт атауы] Мысалы./api/settings/audio.page.vol | Жоқ | {“audio.page.vol”: “-18дБ”} | Барлығы | > 3.3 |
| Децибелмен өлшенген қоршаған шу деңгейін қайтарыңыз. Негізгі параметрлер -> Мүмкіндіктер қойындысында қоршаған шуылдың орнын толтыру мүмкіндігін қосу керек. | АЛУ | /api/info/audio.noise.level | Жоқ | {“audio.noise.level”: 72} | Үндеткіштер Дисплей динамиктері | > 3.3 |
| Релелік кіріс терминалының күйін шығарыңыз. | АЛУ | /api/info/input.relay.status | Жоқ |
{“input.relay.status”: “idle”} немесе {“input.relay.status”: “active”} |
8063-тен басқа релелік кірісі бар барлық өнімдер. Төменде қараңыз. | > 4.1 |
| Кіріс 1 немесе Кіріс 2 терминалдарының күйін шығарыңыз. | АЛУ | /api/info/input.relay1.status немесе /api/info/input.relay2.status | Жоқ | {“input.relay1.status”: “idle”} немесе {“input.relay1.status”: “active”} | 8063 | > 4.1 |
| Тондар тізімін шығарып алыңыз fileқазіргі уақытта орнатылған. | АЛУ | /api/info/tonelist |
Жоқ |
{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]} | Барлығы | > 5.0 |
| Күй бетінде көрсетілетін құрылғы ақпаратын шығарып алыңыз. | АЛУ | /api/info/status | Жоқ | Күй қойындысындағы ақпараттың толық тізімі. | Барлығы | > 5.4 |
| Туралы бетінде көрсетілетін өнім туралы ақпаратты шығарып алыңыз. | АЛУ | /api/info/about | Жоқ | Барлық ақпарат туралы қойындысында бар. | Барлығы | > 5.4 |
| Стробты қажетті түс және үлгі параметрлерімен іске қосыңыз. | POST | /api/controls/strobe/start | үлгі: {0 – 15} түс1: {көк, қызыл, сары, жасыл} түс2: {көк, қызыл, сары, жасыл} ledlvl: {1 – 255} ұстау: {шын, жалған} |
Жоқ | 8128 (G2) 8138 8190S |
> 3.3 |
| Стробты тоқтатыңыз. | POST | /api/controls/strobe/stop | Жоқ | Жоқ | 8128 (G2) 8138 8190S |
> 3.3 |
| Бір дыбысты бір рет ойнатыңыз немесе оны айналдырыңыз. | POST | /api/controls/tone/start | жол: {тон} яғни. chime.wav цикл: {true, false} немесе {0, 1} мысалы, {“path”:”chime.wav”, “loop”:true} |
Жоқ | Баяндамашылар 8301 8373 8028 (G2) 8201 8039 |
> 3.3 |
| Тонды тоқтатыңыз. | POST | /api/controls/tone/stop | Жоқ | Жоқ | Баяндамашылар 8301 8373 8028 (G2) 8201 8039 |
> 3.3 |
| Алдын ала жазылған хабарламамен телефон кеңейтіміне қоңырау шалыңыз. | POST | /api/controls/call/start | {“кеңейтім”:”2099″, “тон”:”gong.wav”, “интервал”:”0″, “maxdur”:”10″} |
Жоқ | Баяндамашылар 8301 8410 8420 |
> 3.3 |
| Қоңырауды аяқтаңыз. | POST | /api/controls/call/stop | Жоқ | Жоқ | Баяндамашылар 8301 8410 8420 |
> 3.3 |
| Бір жақты бет қоңырауын бастаңыз. Құрылғы мақсатты кеңейтімнен дыбыс ағынын алады. | POST | /api/controls/call/page | {"кеңейтім":" ”} | Жоқ | Баяндамашылар 8410 8420 |
> 5.3.4 |
| Мақсатты соңғы нүктені қайта жүктеңіз. | POST | /api/controls/reboot | Жоқ | Жоқ | Барлығы | > 3.3 |
| Есікті ашыңыз. «жергілікті» жергілікті релені басқарады «netdc1» қашықтағы желілік есік контроллерін басқарады (8063) | POST | /api/controls/door/lock | doorid: {local, netdc1} * Қосымша |
Жоқ | 8039 8028 (G2) 8201 8063 |
> 3.3 |
| Есікті құлыптаңыз. | POST | /api/controls/door/lock | doorid: {local, netdc1} * Қосымша |
Жоқ | 8039 8028 (G2) 8201 8063 |
> 3.3 |
| 24в көмекші шығыс релесін қосыңыз. | POST | api/controls/24v/enable | Жоқ | Жоқ | 8063 | > 5.0 |
| 24в қосалқы шығыс релесін өшіріңіз. | POST | api/controls/24v/өшіру | Жоқ | Жоқ | 8063 | > 5.0 |
| Шығыс релесін қосыңыз. | POST | /api/controls/relay/enable | Жоқ | Жоқ | 8063 | > 5.0 |
| Шығу релесін өшіріңіз. | POST | /api/controls/relay/disable | Жоқ | Жоқ | 8063 | > 5.0 |
| Микробағдарламаның соңғы нұсқасын Algo микробағдарлама серверінен тексеріңіз. | POST | /api/controls/upgrade/check | Жоқ | {“нұсқа”: “жаңартылған”} немесе {"нұсқа": " ”} |
Барлығы | > 4.1 |
| Algo микробағдарлама серверінде микробағдарламаның соңғы нұсқасын тексеріңіз және сол нұсқаға жаңартыңыз. | POST | /api/controls/upgrade/start | Жоқ | {“күй”: “жаңартылған”} немесе {"күй": "жаңарту », «url”: url>} немесе {"күй": " ”} |
Барлығы | > 4.1 |
| Экранда кескінді немесе үлгіні көрсетіңіз. | POST | /api/controls/screen/start | Қараңыз төменде | Жоқ | 8410 8420 |
> 5.3.4 |
| Экран үлгісін тоқтатып, әдепкі экранға оралыңыз. | POST | /api/controls/screen/stop | Жоқ | Жоқ | 8410 8420 |
> 5.3.4 |
| Негізгі қолданбаны қайта іске қосыңыз. | POST | /api/controls/қайта жүктеу | Жоқ | Жоқ | Барлығы | > 5.3.4 |
| Тікелей аудио ағынын тыңдауды бастаңыз. Ағын жіберілетін порт нөмірін конфигурациялаңыз. | POST | /api/controls/rx/start | {«порт»: } | Жоқ | Барлығы | > 5.3.4 |
| Тікелей аудио ағынды тыңдауды тоқтатыңыз. | POST | /api/controls/rx/stop | Жоқ | Жоқ | Барлығы | > 5.3.4 |
| Көп тарату режимін орнатыңыз. | ҚОЙ | /api/state/mcast/update/ | {“режим”:”жіберуші”, “адрес”: , «порт»: , “түр”:”rtp”} немесе {“режим”:”жіберуші”, “адрес”: , «порт»: , “түрі”:”поли”, “топ”:1} **Ескертпе**: Егер басқару элементтері/тон/бастау осы пәрменге дейін пайдаланылса, тон ағымдағы параметрлерді пайдаланып ойнатылады. web UI. |
Жоқ | 8301 | > 5.0 |
| JSON пайдалы жүктемесінен белгілі бір параметрге мән енгізіңіз. | ҚОЙ | /api/settings | параметр: {мән} мысалы {“audio.page.vol”: “-3dB”} |
Жоқ | 8180 (G2) 8186 8190 8190S 8301 8373 |
> 3.3 |
Қарапайым басқару интерфейсі (SCI) пәрмендері
Барлық SCI пәрмендері GET сұраулары болып табылады және аутентификация үшін жалпы «usi» және «admin» параметрлеріне ие.
Exampле:
http АЛУ:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local
| Сипаттама | URI | Қосымша Пайдалы жүк Параметрлер | Өнімдер | FW |
| Есікті ашыңыз. «жергілікті» жергілікті релені басқарады «netdc1» қашықтағы желілік есік контроллерін басқарады (8063) |
/sci/controls/do немесе/lock | 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 | жол: {тон} яғни. chime.wav цикл: {true, false} немесе {0, 1} |
Барлығы | > 3.3 |
| Тонды тоқтатыңыз. | /sci/controls/to ne/stop | Жоқ | Барлығы | > 3.3 |
| Стробты қажетті түс және үлгі параметрлерімен іске қосыңыз. | /sci/controls/strobe/start | үлгі: {0 – 15} түс1: {көк, қызыл, сары, жасыл} 2 түс: {көк, қызыл, сары, жасыл} ledlvl: {1 – 255} ұстау: {шын, жалған} |
8128 (G2) 8138 8190S |
> 3.3 |
| Стробты тоқтатыңыз. | /sci/controls/strobe/stop | Жоқ | 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 |