ALGO RESTful API
தயாரிப்பு தகவல்: RESTful API வழிகாட்டி
Algo RESTful API ஆனது பயனர்கள் HTTP/HTTPS கோரிக்கைகள் மூலம் தங்கள் நெட்வொர்க்கில் Algo IP எண்ட்பாயிண்ட்களை அணுகவும், கையாளவும் மற்றும் செயல்களை தூண்டவும் அனுமதிக்கிறது. இந்த ஆவணம் ஒரே மாதிரியான மற்றும் முன் வரையறுக்கப்பட்ட நிலையற்ற செயல்பாடுகளை வழங்குகிறது, அவை Algo சாதனங்களுடன் தொடர்பு கொள்ள பயன்படுத்தப்படலாம். JSON பேலோடுகளுடன் HTTP/HTTPS GET, POST மற்றும் PUT கோரிக்கைகளை API ஆதரிக்கிறது.
அங்கீகாரம்
Algo RESTful API உடன் மூன்று வகையான அங்கீகாரங்கள் உள்ளன:
- நிலையான அங்கீகாரம் (இயல்புநிலையாக இயக்கப்பட்டது)
- அடிப்படை அங்கீகாரம் (விரும்பினால்)
- அங்கீகார முறை இல்லை (பரிந்துரைக்கப்படவில்லை; சோதனை நோக்கங்களுக்காக மட்டும்)
தயாரிப்பு பயன்பாட்டு வழிமுறைகள்: RESTful API
முன்நிபந்தனைகள்
RESTful API ஐ இயக்குவதற்கு முன், முன்பே உள்ளமைக்கப்பட்ட NTP சேவையகங்களை அடைய சாதனத்தில் இணைய இணைப்பு இருப்பதை உறுதிசெய்யவும். இணைய இணைப்பு இல்லை என்றால், உள்ளூர் என்டிபி சர்வரை உள்ளமைத்து அதன் ஐபி முகவரியை உள்ளிடவும்.
RESTful API ஐ இயக்குகிறது
- சாதனத்தில் உள்நுழைக web இடைமுகம் மற்றும் மேம்பட்ட அமைப்புகள் நிர்வாகம் தாவலுக்கு செல்லவும்.
- API ஆதரவு பகுதிக்கு கீழே உருட்டி, RESTful API ஐ இயக்கவும்.
- விரும்பிய கடவுச்சொல்லை அமைக்கவும் (இயல்புநிலை கடவுச்சொல்: அல்கோ). இயல்புநிலை அங்கீகாரம் இயல்பாகவே இயக்கப்பட்டது என்பதை நினைவில் கொள்ளவும்.
அடிப்படை அங்கீகாரத்தை இயக்குகிறது (விரும்பினால்)
- இல் web இடைமுகம், கணினி பராமரிப்பு தாவலுக்குச் சென்று உள்ளமைவைப் பதிவிறக்கவும் file.
- உள்ளமைவைத் திறக்கவும் file ஏதேனும் உரை திருத்தியுடன் பின்வரும் வரியைச் சேர்க்கவும்: api.auth.basic = 1
- மாற்றியமைக்கப்பட்ட கட்டமைப்பைச் சேமித்து பதிவேற்றவும் file மீட்டமை கட்டமைப்பைப் பயன்படுத்தி சாதனத்திற்குத் திரும்பு File கணினி பராமரிப்பு தாவலில் உள்ள அம்சம்.
அங்கீகார முறை இல்லை என்பதை இயக்குகிறது (விரும்பினால்)
அங்கீகாரம் இல்லாத முறையை இயக்க, RESTful API கடவுச்சொல் புலத்தை காலியாக விடவும். இந்த முறை பரிந்துரைக்கப்படவில்லை, மேலும் இது பாதுகாப்பை வழங்காததால் சோதனை நோக்கங்களுக்காக மட்டுமே பயன்படுத்தப்பட வேண்டும்.
எளிய கட்டுப்பாட்டு இடைமுகத்தை இயக்குகிறது (விரும்பினால்)
- அன்று web இடைமுகம், கணினி பராமரிப்பு தாவலுக்குச் சென்று உள்ளமைவைப் பதிவிறக்கவும் file.
- உள்ளமைவைத் திறக்கவும் file உரை திருத்தியைப் பயன்படுத்தி இரண்டு வரிகளைச் சேர்க்கவும். நீங்கள் விரும்பும் கடவுச்சொல்லை மாற்றவும்.
- நிர்வாகி.web.sci = 1
- Sci.admin.pwd =
- மாற்றியமைக்கப்பட்ட கட்டமைப்பைச் சேமித்து பதிவேற்றவும் file மீட்டமை கட்டமைப்பைப் பயன்படுத்தி சாதனத்திற்குத் திரும்பு File கணினி பராமரிப்பு தாவலில் உள்ள அம்சம்.
அங்கீகாரம் எஸ்ample கோட்
மின்னஞ்சல் செய்யவும் support@algosolutions.com நீங்கள் ஒரு நிலையான அல்லது அடிப்படை அங்கீகாரத்தை விரும்பினால் sample குறியீடு.
கூடுதல் ஆதரவுக்கு, அழைக்கவும் 604-454-3792 அல்லது மின்னஞ்சல் support@algosolutions.com
தகவல் அறிவிப்புகள்
குறிப்பு
குறிப்பு பயனுள்ள புதுப்பிப்புகள், தகவல் மற்றும் பின்பற்ற வேண்டிய வழிமுறைகளைக் குறிக்கிறது
மறுப்பு
இந்த ஆவணத்தில் உள்ள தகவல்கள் எல்லா வகையிலும் துல்லியமானவை என நம்பப்படுகிறது ஆனால் அல்கோவால் உத்தரவாதம் அளிக்கப்படவில்லை. தகவல் எந்த அறிவிப்பும் இல்லாமல் மாற்றத்திற்கு உட்பட்டது மற்றும் Algo அல்லது அதன் துணை நிறுவனங்கள் அல்லது துணை நிறுவனங்களால் எந்த வகையிலும் உறுதிப் படுத்தப்படக் கூடாது. இந்த ஆவணத்தில் ஏதேனும் பிழைகள் அல்லது குறைபாடுகளுக்கு Algo மற்றும் அதன் துணை நிறுவனங்கள் மற்றும் துணை நிறுவனங்கள் பொறுப்பேற்காது. அத்தகைய மாற்றங்களைச் சேர்க்க இந்த ஆவணத்தின் திருத்தங்கள் அல்லது அதன் புதிய பதிப்புகள் வெளியிடப்படலாம். இந்த கையேடு அல்லது அத்தகைய தயாரிப்புகள், மென்பொருள், ஃபார்ம்வேர் மற்றும்/அல்லது வன்பொருளின் எந்தவொரு பயன்பாட்டின் விளைவாக ஏற்படும் சேதங்கள் அல்லது உரிமைகோரல்களுக்கு Algo பொறுப்பேற்காது. இந்த ஆவணத்தின் எந்தப் பகுதியையும், அல்கோவின் எழுத்துப்பூர்வ அனுமதியின்றி, எந்தவொரு வடிவத்திலும் அல்லது எந்த வகையிலும் - எலக்ட்ரானிக் அல்லது மெக்கானிக்கல் - எந்த நோக்கத்திற்காகவும் மீண்டும் உருவாக்கவோ அல்லது அனுப்பவோ முடியாது.
வட அமெரிக்காவில் கூடுதல் தகவல் அல்லது தொழில்நுட்ப உதவிக்கு, அல்கோவின் ஆதரவுக் குழுவைத் தொடர்பு கொள்ளவும்:
அல்கோ தொழில்நுட்ப ஆதரவு
1-604-454-3792
support@algosolutions.com
©2022 Algo என்பது Algo Communication Products Ltd இன் பதிவுசெய்யப்பட்ட வர்த்தக முத்திரையாகும்.
அனைத்து உரிமைகளும் பாதுகாக்கப்பட்டவை. மற்ற அனைத்து வர்த்தக முத்திரைகளும் அந்தந்த உரிமையாளர்களின் சொத்து. அனைத்து விவரக்குறிப்புகளும் அறிவிப்பு இல்லாமல் மாற்றத்திற்கு உட்பட்டவை.
பொது
அறிமுகம்
HTTP/HTTPS கோரிக்கைகள் மூலம் உங்கள் நெட்வொர்க்கில் Algo IP எண்ட்பாயிண்ட்டுகளை அணுகவும், கையாளவும் மற்றும் செயல்களைத் தூண்டவும் Algo RESTful API எவ்வாறு பயன்படுத்தப்படலாம் என்பதை இந்த ஆவணம் விவரிக்கிறது. இந்த ஆவணத்தில் வரையறுக்கப்பட்டுள்ள சீரான மற்றும் முன் வரையறுக்கப்பட்ட நிலையற்ற செயல்பாடுகளின் மூலம் கோரிக்கை அமைப்புகள் Algo சாதனங்களுடன் தொடர்பு கொள்ளலாம். JSON பேலோடுடன் ஒரு ஆதாரத்தின் URI க்கு கோரிக்கைகள் செய்யப்பட்டு JSON பதிலைப் பெறுகின்றன. HTTP/HTTPS GET, POST மற்றும் PUT கோரிக்கைகள் JSON பேலோடுடன் ஆதார URIக்கு செய்யப்படுகின்றன (பேலோடுகளின் பட்டியலுக்கு கட்டளைகள் பகுதியைப் பார்க்கவும்).
அங்கீகாரம்
மூன்று வகையான அங்கீகாரங்கள் உள்ளன:
- தரநிலை (பரிந்துரைக்கப்பட்டது)
- அடிப்படை
- எதுவும் இல்லை (பரிந்துரைக்கப்படவில்லை)
நிலையான அங்கீகாரமானது, SHA-256 குறியிடப்பட்ட டைஜெஸ்டுடன் ஹாஷ் அடிப்படையிலான செய்தி அங்கீகாரக் குறியீட்டைப் (HMAC) பயன்படுத்துகிறது. அடிப்படை அங்கீகாரம் Base64 குறியாக்கத்தைப் பயன்படுத்துகிறது மற்றும் HTTPS இல் மட்டுமே பயன்படுத்தப்பட வேண்டும். எந்த அங்கீகாரத்தையும் மிகுந்த கவனத்துடன் பயன்படுத்தக்கூடாது, ஏனெனில் அது எந்த அங்கீகாரத்தையும் அளிக்காது. மேலும் விவரங்களுக்கு அங்கீகாரத் தேவைகள் பகுதியைப் பார்க்கவும்.
அமைவு மற்றும் கட்டமைப்பு
முன்நிபந்தனைகள்
- இந்த ஆவணம் Algo எண்ட்பாயிண்ட் ஃபார்ம்வேர் பதிப்பு 3.3 அல்லது அதற்கு மேல் இயங்குகிறது என்று கருதுகிறது.
- நிலையான அங்கீகாரத்தைப் பயன்படுத்த, கோரிக்கையாளருக்கும் அல்கோ சாதனங்களுக்கும் இடையிலான நேர வித்தியாசம் 30 வினாடிகளுக்கும் குறைவாக இருக்க வேண்டும்.
- என்டிபி (நெட்வொர்க் டைம் புரோட்டோகால்) பயன்பாட்டில் இருப்பதை உறுதிசெய்யவும். தனிப்பயன் NTP சேவையகங்களின் முகவரிகள் மேம்பட்ட அமைப்புகள் → நேரம் தாவலில் கட்டமைக்கப்படலாம்.
குறிப்பு
முன்பே கட்டமைக்கப்பட்ட NTP சேவையகங்கள் பொதுவில் ஹோஸ்ட் செய்யப்பட்டுள்ளன, எனவே அதை அடைய இணைய இணைப்பு தேவை. இணைய இணைப்பு இல்லை என்றால், உள்ளூர் என்டிபி சர்வரை உள்ளமைத்து அதன் ஐபி முகவரியை உள்ளிடவும்.
- ஆல்கோ சாதன அமைப்பு நேரம் சரியான நேர மண்டலத்திற்குச் சரிப்படுத்தப்பட்டுள்ளதை உறுதிசெய்யவும். மேம்பட்ட அமைப்புகள் → நேரத் தாவலுக்குச் செல்வதன் மூலம் இதைச் செய்யலாம்.
RESTful API ஐ இயக்குகிறது
- உள்நுழைக web இடைமுகம் மற்றும் மேம்பட்ட அமைப்புகள் → நிர்வாகம் தாவலுக்கு செல்லவும்.
- API ஆதரவு பிரிவுக்கு கீழே உருட்டவும், RESTful API ஐ இயக்கவும் மற்றும் கடவுச்சொல்லை விரும்பியபடி அமைக்கவும் (இயல்புநிலை கடவுச்சொல்: அல்கோ)
குறிப்பு
நிலையான அங்கீகாரம் இயல்பாகவே இயக்கப்பட்டது.
அடிப்படை அங்கீகாரத்தை இயக்கு (விரும்பினால்)
- இல் web இடைமுகம், சிஸ்டம் → பராமரிப்பு தாவலுக்குச் சென்று உள்ளமைவைப் பதிவிறக்கவும் file.
- உள்ளமைவைத் திறக்கவும் file ஏதேனும் உரை திருத்தியுடன் பின்வரும் வரியைச் சேர்க்கவும்: api.auth.basic = 1
- மாற்றியமைக்கப்பட்ட கட்டமைப்பைச் சேமித்து பதிவேற்றவும் file மீட்டமை கட்டமைப்பைப் பயன்படுத்தி சாதனத்திற்குத் திரும்பு File கணினி → பராமரிப்பு தாவலில் உள்ள அம்சம்.
அங்கீகார முறை இல்லை (விரும்பினால்)
அங்கீகாரம் இல்லாத முறையை இயக்க, RESTful API கடவுச்சொல் புலத்தை காலியாக விடவும். இந்த முறை பரிந்துரைக்கப்படவில்லை, மேலும் இது பாதுகாப்பை வழங்காததால் சோதனை நோக்கங்களுக்காக மட்டுமே பயன்படுத்தப்பட வேண்டும்.
எளிய கட்டுப்பாட்டு இடைமுகத்தை இயக்குகிறது (விரும்பினால்)
- அன்று web இடைமுகம், சிஸ்டம் → பராமரிப்பு தாவலுக்குச் சென்று உள்ளமைவைப் பதிவிறக்கவும் file.
- உள்ளமைவைத் திறக்கவும் file உரை திருத்தியைப் பயன்படுத்தி இரண்டு வரிகளைச் சேர்க்கவும். மாற்றவும் உங்கள் விருப்பமான கடவுச்சொல்லுக்கு. நிர்வாகி.web.sci = 1
Sci.admin.pwd = - மாற்றியமைக்கப்பட்ட கட்டமைப்பைச் சேமித்து பதிவேற்றவும் file மீட்டமை கட்டமைப்பைப் பயன்படுத்தி சாதனத்திற்குத் திரும்பு File கணினி → பராமரிப்பு தாவலில் உள்ள அம்சம்.
அங்கீகாரத் தேவைகள்
மின்னஞ்சல் செய்யவும் support@algosolutions.com நீங்கள் ஒரு நிலையான அல்லது அடிப்படை அங்கீகாரத்தை விரும்பினால் sample குறியீடு.
JSON பேலோடுடன் நிலையான அங்கீகாரக் கோரிக்கை
HTTP/HTTPS கோரிக்கையில் தேவையான தலைப்புகள்
> உள்ளடக்க வகை: “பயன்பாடு/ஜோசன்”
> உள்ளடக்கம்-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b
அங்கீகாரம்: hmac admin:[nonce]:[hmac_output]
அங்கீகார தலைப்புகளில் பின்வருவன அடங்கும்:
- 'hmac admin' என்ற சரத்தைத் தொடர்ந்து ஒரு பெருங்குடல் ':'.
- Nonce – ஒரு சீரற்ற அல்லது திரும்பத் திரும்ப வராத மதிப்பு, அதைத் தொடர்ந்து ஒரு பெருங்குடல் ':'.
- Hmac_output - கீழே உள்ளபடி உங்கள் சாதனம் மற்றும் HMAC உள்ளீட்டில் உள்ளமைக்கப்பட்ட RESTful API கடவுச்சொல் (இரகசிய-விசை) மூலம் உருவாக்கப்பட்டது:
[request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[எப்போதும்]
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
பேலோட் எக்ஸ் உடன் நிலையான அங்கீகாரம்ampலெ:
JSON பேலோட் இல்லாமல் நிலையான அங்கீகாரக் கோரிக்கை
உள்ளடக்கம் தொடர்பான தலைப்புகள்/hmac உள்ளீடு தவிர்க்கப்பட்ட 3.1ஐ ஒத்தது.
HMAC உள்ளீடு: [request_method]:[request_uri]:[timestamp]:[nonce] HMAC உள்ளீடு முன்னாள்ample: ('algo' ஐ இரகசிய விசையாகப் பயன்படுத்துதல்)
GET:/api/settings/audio.page.vol:1601312252:49936
SHA-256 ஐப் பயன்படுத்தி கடவுச்சொல் மற்றும் HMAC உள்ளீடு சரத்துடன் HMAC ஐ உருவாக்கவும்:
HMAC வெளியீடு முன்னாள்ample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
பேலோட் இல்லாமல் நிலையான அங்கீகாரம் முன்னாள்ampலெ:
அடிப்படை அங்கீகார கோரிக்கை
இந்த அங்கீகார முறையானது நிலையான முறையை விட குறைவான பாதுகாப்பானது என்பதால் கவனமாகப் பயன்படுத்த வேண்டும்.
அங்கீகாரம்: அடிப்படை [base64]
Exampலெ:
அங்கீகாரம்: அடிப்படை YWRtaW46YWxnbwo=
அடிப்படை அங்கீகாரம் exampலெ:
கட்டளைகள்
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 |
உள்ளீடு 1 அல்லது உள்ளீடு 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 |
{“டோனலிஸ்ட்”:[“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/கட்டுப்பாடுகள்/strobe/start | முறை: {0 – 15} நிறம்1: {நீலம், சிவப்பு, அம்பர், பச்சை} நிறம்2: {நீலம், சிவப்பு, அம்பர், பச்சை} ledlvl: {1 – 255} ஹோல்டோவர்: {உண்மை, பொய்} |
N/A | 8128(G2) 8138 8190S |
> 3.3 |
ஸ்ட்ரோபை நிறுத்துங்கள். | இடுகை | /api/கட்டுப்பாடுகள்/strobe/stop | N/A | N/A | 8128(G2) 8138 8190S |
> 3.3 |
ஒரு டோனை ஒருமுறை இயக்கவும் அல்லது லூப் செய்யவும். | இடுகை | /api/கட்டுப்பாடுகள்/தொனி/தொடக்கம் | பாதை: {தொனி} அதாவது. மணி.வேவ் வளையம்: {true, false} அல்லது {0, 1} எ.கா. {“பாதை”:”chime.wav”, “லூப்”:true} |
N/A | பேச்சாளர்கள் 8301 8373 8028(G2) 8201 8039 |
> 3.3 |
தொனியை நிறுத்து. | இடுகை | /api/கட்டுப்பாடுகள்/தொனி/நிறுத்தம் | N/A | N/A | பேச்சாளர்கள் 8301 8373 8028(G2) 8201 8039 |
> 3.3 |
முன்பே பதிவுசெய்யப்பட்ட செய்தியுடன் தொலைபேசி நீட்டிப்பை அழைக்கவும். | இடுகை | /api/கட்டுப்பாடுகள்/அழைப்பு/தொடக்கம் | {“நீட்டிப்பு”:”2099″, “தொனி”:”gong.wav”, “இடைவெளி”:”0″, “maxdur”:”10″} |
N/A | பேச்சாளர்கள் 8301 8410 8420 |
> 3.3 |
அழைப்பை முடிக்கவும். | இடுகை | /api/கட்டுப்பாடுகள்/அழைப்பு/நிறுத்து | N/A | N/A | பேச்சாளர்கள் 8301 8410 8420 |
> 3.3 |
ஒரு வழி பக்க அழைப்பைத் தொடங்கவும். இலக்கு நீட்டிப்பிலிருந்து சாதனம் ஆடியோ ஸ்ட்ரீமைப் பெறும். | இடுகை | /api/கட்டுப்பாடுகள்/அழைப்பு/பக்கம் | {“நீட்டிப்பு”:” ”} | N/A | பேச்சாளர்கள் 8410 8420 |
> 5.3.4 |
இலக்கு இறுதிப் புள்ளியை மீண்டும் துவக்கவும். | இடுகை | / api / கட்டுப்பாடுகள் / மறுதொடக்கம் | N/A | N/A | அனைத்து | > 3.3 |
கதவைத் திற. "உள்ளூர்" உள்ளூர் ரிலேவைக் கட்டுப்படுத்துகிறது "netdc1" ரிமோட் நெட்வொர்க் கதவு கட்டுப்படுத்தியைக் கட்டுப்படுத்துகிறது (8063) | இடுகை | /api/கட்டுப்பாடுகள்/கதவு/திறத்தல் | கதவு: {உள்ளூர், netdc1} * விரும்பினால் |
N/A | 8039 8028(G2) 8201 8063 |
> 3.3 |
கதவைப் பூட்டு. | இடுகை | / api / கட்டுப்பாடுகள் / கதவு / பூட்டு | கதவு: {உள்ளூர், netdc1} * விரும்பினால் |
N/A | 8039 8028(G2) 8201 8063 |
> 3.3 |
24v ஆக்ஸ் அவுட் ரிலேவை இயக்கவும். | இடுகை | api/controls/24v/enable | N/A | N/A | 8063 | > 5.0 |
24v ஆக்ஸ் அவுட் ரிலேவை முடக்கு. | இடுகை | api/கட்டுப்பாடுகள்/24v/முடக்கு | N/A | N/A | 8063 | > 5.0 |
வெளியீட்டு ரிலேவை இயக்கவும். | இடுகை | /api/கட்டுப்பாடுகள்/ரிலே/இயக்கு | N/A | N/A | 8063 | > 5.0 |
வெளியீட்டு ரிலேவை முடக்கு. | இடுகை | /api/கட்டுப்பாடுகள்/ரிலே/முடக்கு | N/A | N/A | 8063 | > 5.0 |
சமீபத்திய ஃபார்ம்வேர் பதிப்பிற்கு அல்கோவின் ஃபார்ம்வேர் சர்வரைச் சரிபார்க்கவும். | இடுகை | /api/கட்டுப்பாடுகள்/மேம்படுத்துதல்/சரிபார்த்தல் | N/A | {“பதிப்பு”: “புதுப்பிக்கப்பட்டது”} அல்லது {“பதிப்பு”: “ ”} |
அனைத்து | > 4.1 |
சமீபத்திய ஃபார்ம்வேர் பதிப்பிற்காக அல்கோவின் ஃபார்ம்வேர் சேவையகத்தைச் சரிபார்த்து, அந்தப் பதிப்பிற்கு மேம்படுத்தவும். | இடுகை | /api/கட்டுப்பாடுகள்/மேம்படுத்துதல்/தொடக்கம் | N/A | {“நிலை”: “புதுப்பிக்கப்பட்டது”} அல்லது {"நிலை": "மேம்படுத்துதல் ”,”url”: url>} அல்லது {"நிலை": " ”} |
அனைத்து | > 4.1 |
திரையில் ஒரு படம் அல்லது வடிவத்தைக் காட்டவும். | இடுகை | /api/கட்டுப்பாடுகள்/திரை/தொடக்கம் | பார்க்கவும் கீழே | N/A | 8410 8420 |
> 5.3.4 |
திரை வடிவத்தை நிறுத்திவிட்டு இயல்புநிலைத் திரைக்குத் திரும்பவும். | இடுகை | /api/கட்டுப்பாடுகள்/திரை/நிறுத்தம் | N/A | N/A | 8410 8420 |
> 5.3.4 |
முக்கிய பயன்பாட்டை மறுதொடக்கம் செய்யுங்கள். | இடுகை | /api/கட்டுப்பாடுகள்/ரீலோட் | 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 |
மல்டிகாஸ்ட் பயன்முறையை அமைக்கவும். | PUT | /api/state/mcast/update/ | {“முறை”:”அனுப்புபவர்”, “முகவரி”: , "போர்ட்": , “வகை”:”rtp”} அல்லது {“முறை”:”அனுப்புபவர்”, “முகவரி”: , "போர்ட்": , “வகை”:”பாலி”, “குழு”:1} **குறிப்பு**: இந்தக் கட்டளைக்கு முன் கட்டுப்பாடுகள்/தொனி/தொடக்கம் பயன்படுத்தப்பட்டால், டோன் தற்போதைய அமைப்புகளைப் பயன்படுத்தி இயங்கும் web பயனர் இடைமுகம். |
N/A | 8301 | > 5.0 |
JSON பேலோடில் இருந்து ஒரு குறிப்பிட்ட அளவுருவிற்கு மதிப்பைச் செருகவும். | PUT | /api/settings | அளவுரு: {value} எ.கா. {“audio.page.vol”: “-3dB”} |
N/A | 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) |
/அறிவியல்/கட்டுப்பாடுகள்/செய் அல்லது/திறத்தல் | கதவு: {உள்ளூர், netdc1} * விரும்பினால் |
8039 8028(G2) 8201 8063 |
> 3.3 |
கதவைப் பூட்டு. | /அறிவியல்/கட்டுப்பாடுகள்/செய் அல்லது/பூட்டு | கதவு: {உள்ளூர், netdc1} * விரும்பினால் |
8039 8028(G2) 8201 8063 |
> 3.3 |
ஒரு டோனை ஒருமுறை இயக்கவும் அல்லது லூப் செய்யவும். | /அறிவியல்/கட்டுப்பாடுகள்/நீ/தொடக்க | பாதை: {தொனி} அதாவது. மணி.வேவ் வளையம்: {true, false} அல்லது {0, 1} |
அனைத்து | > 3.3 |
தொனியை நிறுத்து. | /அறிவியல்/கட்டுப்பாடுகள்/நிறுத்தம் | N/A | அனைத்து | > 3.3 |
விரும்பிய வண்ணம் மற்றும் வடிவ அளவுருக்களுடன் ஸ்ட்ரோபை இயக்கவும். | /அறிவியல்/கட்டுப்பாடுகள்/ஸ்ட்ரோப்/தொடக்கம் | முறை: {0 – 15} நிறம்1: {நீலம், சிவப்பு, அம்பர், பச்சை} நிறம்2: {நீலம், சிவப்பு, அம்பர், பச்சை} ledlvl: {1 – 255} ஹோல்டோவர்: {true, false} |
8128(G2) 8138 8190S |
> 3.3 |
ஸ்ட்ரோபை நிறுத்துங்கள். | /அறிவியல்/கட்டுப்பாடுகள்/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 |