ALGO RESTful API
ఉత్పత్తి సమాచారం: RESTful API గైడ్
Algo RESTful API వినియోగదారులను HTTP/HTTPS అభ్యర్థనల ద్వారా వారి నెట్‌వర్క్‌లోని Algo IP ఎండ్‌పాయింట్‌లను యాక్సెస్ చేయడానికి, మానిప్యులేట్ చేయడానికి మరియు ట్రిగ్గర్ చేయడానికి అనుమతిస్తుంది. ఈ పత్రం ఆల్గో పరికరాలతో పరస్పర చర్య చేయడానికి ఉపయోగించే స్థితిలేని కార్యకలాపాల యొక్క ఏకరీతి మరియు ముందే నిర్వచించబడిన సెట్‌ను అందిస్తుంది. API JSON పేలోడ్‌లతో HTTP/HTTPS GET, POST మరియు PUT అభ్యర్థనలకు మద్దతు ఇస్తుంది.
ప్రమాణీకరణ
Algo RESTful APIతో మూడు రకాల ప్రమాణీకరణలు అందుబాటులో ఉన్నాయి:
- ప్రామాణిక ప్రమాణీకరణ (డిఫాల్ట్‌గా ప్రారంభించబడింది)
- ప్రాథమిక ప్రమాణీకరణ (ఐచ్ఛికం)
- ప్రమాణీకరణ పద్ధతి లేదు (సిఫార్సు చేయబడలేదు; పరీక్ష ప్రయోజనాల కోసం మాత్రమే)
ఉత్పత్తి వినియోగ సూచనలు: RESTful API
ముందస్తు అవసరాలు
RESTful APIని ప్రారంభించే ముందు, ముందుగా కాన్ఫిగర్ చేయబడిన NTP సర్వర్‌లను చేరుకోవడానికి పరికరం ఇంటర్నెట్ కనెక్షన్‌ని కలిగి ఉందని నిర్ధారించుకోండి. ఇంటర్నెట్ కనెక్షన్ అందుబాటులో లేకుంటే, స్థానిక NTP సర్వర్‌ని కాన్ఫిగర్ చేసి, దాని IP చిరునామాను నమోదు చేయండి.
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 సిస్టమ్ మెయింటెనెన్స్ ట్యాబ్‌లో ఫీచర్.
ప్రమాణీకరణ Sampలే కోడ్
దయచేసి ఇమెయిల్ చేయండి support@algosolutions.com మీరు ప్రామాణిక లేదా ప్రాథమిక ప్రమాణీకరణ కావాలనుకుంటే sampలే కోడ్.
అదనపు మద్దతు కోసం, కాల్ చేయండి 604-454-3792 లేదా ఇమెయిల్ support@algosolutions.com
సమాచార నోటీసులు
గమనిక
గమనిక ఉపయోగకరమైన నవీకరణలు, సమాచారం మరియు అనుసరించాల్సిన సూచనలను సూచిస్తుంది
నిరాకరణ
ఈ పత్రంలో ఉన్న సమాచారం అన్ని విధాలుగా ఖచ్చితమైనదని విశ్వసించబడింది కానీ ఆల్గో ద్వారా హామీ ఇవ్వబడలేదు. సమాచారం నోటీసు లేకుండా మార్చబడవచ్చు మరియు ఆల్గో లేదా దాని అనుబంధ సంస్థలు లేదా అనుబంధ సంస్థల ద్వారా ఏ విధంగానూ నిబద్ధతగా భావించకూడదు. ఆల్గో మరియు దాని అనుబంధ సంస్థలు మరియు అనుబంధ సంస్థలు ఈ పత్రంలో ఏవైనా లోపాలు లేదా లోపాలకు బాధ్యత వహించవు. అటువంటి మార్పులను చేర్చడానికి ఈ పత్రం యొక్క పునర్విమర్శలు లేదా దాని యొక్క కొత్త సంచికలు జారీ చేయబడవచ్చు. ఆల్గో ఈ మాన్యువల్ లేదా అటువంటి ఉత్పత్తులు, సాఫ్ట్‌వేర్, ఫర్మ్‌వేర్ మరియు/లేదా హార్డ్‌వేర్ యొక్క ఏదైనా ఉపయోగం వల్ల కలిగే నష్టాలు లేదా క్లెయిమ్‌లకు ఎటువంటి బాధ్యత వహించదు. ఆల్గో నుండి వ్రాతపూర్వక అనుమతి లేకుండా ఏ ఉద్దేశానికైనా - ఎలక్ట్రానిక్ లేదా మెకానికల్ - ఈ పత్రంలోని ఏ భాగాన్ని ఏ రూపంలోనైనా లేదా ఏ విధంగానైనా పునరుత్పత్తి చేయడం లేదా ప్రసారం చేయడం సాధ్యం కాదు.
ఉత్తర అమెరికాలో అదనపు సమాచారం లేదా సాంకేతిక సహాయం కోసం, దయచేసి Algo మద్దతు బృందాన్ని సంప్రదించండి:
ఆల్గో టెక్నికల్ సపోర్ట్
1-604-454-3792
support@algosolutions.com
©2022 ఆల్గో అనేది ఆల్గో కమ్యూనికేషన్ ప్రోడక్ట్స్ లిమిటెడ్ యొక్క రిజిస్టర్డ్ ట్రేడ్‌మార్క్.
సర్వ హక్కులు ప్రత్యేకించబడినవి. అన్ని ఇతర ట్రేడ్‌మార్క్‌లు వాటి సంబంధిత యజమానుల ఆస్తి. అన్ని స్పెసిఫికేషన్‌లు నోటీసు లేకుండా మారవచ్చు.
సాధారణ
పరిచయం
HTTP/HTTPS అభ్యర్థనల ద్వారా మీ నెట్‌వర్క్‌లోని Algo IP ఎండ్‌పాయింట్‌లను యాక్సెస్ చేయడానికి, మానిప్యులేట్ చేయడానికి మరియు చర్యలను ట్రిగ్గర్ చేయడానికి Algo RESTful API ఎలా ఉపయోగించబడుతుందో ఈ పత్రం వివరిస్తుంది, అలాగే వివిధ స్థాయిల భద్రతతో కూడిన రెండు విభిన్న ప్రమాణీకరణ పద్ధతులను వివరిస్తుంది. రిక్వెస్టింగ్ సిస్టమ్‌లు ఈ డాక్యుమెంట్‌లో నిర్వచించిన ఏకరీతి మరియు ముందే నిర్వచించబడిన స్థితిరహిత కార్యకలాపాల ద్వారా ఆల్గో పరికరాలతో పరస్పర చర్య చేయవచ్చు. JSON పేలోడ్‌తో రిసోర్స్ యొక్క URIకి అభ్యర్థనలు చేయబడతాయి మరియు JSON ప్రతిస్పందనను పొందుతాయి. HTTP/HTTPS GET, POST మరియు PUT అభ్యర్థనలు JSON పేలోడ్‌తో పాటు వనరుల URIకి అందించబడతాయి (పేలోడ్‌ల జాబితా కోసం ఆదేశాల విభాగాన్ని చూడండి).
ప్రమాణీకరణ
మూడు రకాల ధృవీకరణలు ఉన్నాయి:
- ప్రామాణికం (సిఫార్సు చేయబడింది)
- ప్రాథమిక
- ఏదీ లేదు (సిఫార్సు చేయబడలేదు)
ప్రామాణిక ప్రమాణీకరణ SHA-256 ఎన్‌కోడ్ డైజెస్ట్‌తో హాష్-ఆధారిత సందేశ ప్రమాణీకరణ కోడ్ (HMAC)ని ఉపయోగిస్తుంది. ప్రాథమిక ప్రమాణీకరణ Base64 ఎన్‌కోడింగ్‌ని ఉపయోగిస్తుంది మరియు HTTPS ద్వారా మాత్రమే ఉపయోగించబడుతుంది. ఏ ప్రామాణీకరణను అత్యంత జాగ్రత్తతో మాత్రమే ఉపయోగించకూడదు ఎందుకంటే ఇది ఎటువంటి ప్రమాణీకరణను అందించదు. మరిన్ని వివరాల కోసం ప్రామాణీకరణ అవసరాల విభాగాన్ని చూడండి.
సెటప్ మరియు కాన్ఫిగరేషన్
ముందస్తు అవసరాలు
- ఈ పత్రం ఆల్గో ఎండ్‌పాయింట్ ఫర్మ్‌వేర్ వెర్షన్ 3.3 లేదా అంతకంటే ఎక్కువ రన్ అవుతుందని ఊహిస్తుంది.
- ప్రామాణిక ప్రమాణీకరణను ఉపయోగించడానికి అభ్యర్థన మరియు ఆల్గో పరికరాల మధ్య సమయ వ్యత్యాసం 30 సెకన్ల కంటే తక్కువగా ఉండాలి.
- NTP (నెట్‌వర్క్ టైమ్ ప్రోటోకాల్) ఉపయోగంలో ఉందని నిర్ధారించుకోండి. అనుకూల NTP సర్వర్‌ల చిరునామాలు అధునాతన సెట్టింగ్‌లు → టైమ్ ట్యాబ్‌లో కాన్ఫిగర్ చేయబడవచ్చు.
గమనిక
ముందుగా కాన్ఫిగర్ చేయబడిన NTP సర్వర్‌లు పబ్లిక్‌గా హోస్ట్ చేయబడ్డాయి, కాబట్టి దాన్ని చేరుకోవడానికి ఇంటర్నెట్ కనెక్షన్ అవసరం. ఇంటర్నెట్ కనెక్షన్ అందుబాటులో లేకుంటే, స్థానిక NTP సర్వర్‌ని కాన్ఫిగర్ చేసి, దాని IP చిరునామాను నమోదు చేయండి.
- ఆల్గో పరికర సిస్టమ్ సమయం సరైన టైమ్ జోన్‌కు సర్దుబాటు చేయబడిందని నిర్ధారించుకోండి. అధునాతన సెట్టింగ్‌లు → టైమ్ ట్యాబ్‌కు నావిగేట్ చేయడం ద్వారా ఇది చేయవచ్చు.
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 మీరు ప్రామాణిక లేదా ప్రాథమిక ప్రమాణీకరణ కావాలనుకుంటే sampలే కోడ్.
JSON పేలోడ్‌తో ప్రామాణిక ప్రమాణీకరణ అభ్యర్థన
HTTP/HTTPS అభ్యర్థనలో అవసరమైన శీర్షికలు
> కంటెంట్-రకం: “అప్లికేషన్/json”
> కంటెంట్-MD5: [content_md5] ఉదాample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b
ఆథరైజేషన్: hmac అడ్మిన్:[nonce]:[hmac_output]
అధికార శీర్షికలు వీటిని కలిగి ఉంటాయి:
- స్ట్రింగ్ 'hmac అడ్మిన్' తర్వాత కోలన్ ':'.
- నాన్స్ – యాదృచ్ఛిక లేదా పునరావృతం కాని విలువ, తర్వాత కోలన్ ':'.
- Hmac_output – మీ పరికరంలో మరియు HMAC ఇన్‌పుట్‌లో కాన్ఫిగర్ చేయబడిన RESTful API పాస్‌వర్డ్ (రహస్య-కీ) ద్వారా రూపొందించబడింది, ఈ క్రింది విధంగా:
[request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[కాదు]
HMAC ఇన్‌పుట్ మాజీample: ('algo' ను రహస్య కీగా ఉపయోగించడం)
POST:/api/నియంత్రణలు/టోన్/ప్రారంభం:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 HMACని పాస్‌వర్డ్‌తో మరియు HMAC ఇన్‌పుట్ స్ట్రింగ్‌ను డైజెస్ట్‌గా రూపొందించండి: SHA-256
HMAC అవుట్‌పుట్ ఉదాample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330
తేదీ: రోజు, తేదీ నెల, సంవత్సరం గం:నిమి: సెకన్లు 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=
ప్రాథమిక ప్రమాణీకరణ ఉదాampలే:
ఆదేశాలు
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/నియంత్రణలు/స్ట్రోబ్/ప్రారంభం | నమూనా: {0 – 15} color1: {నీలం, ఎరుపు, కాషాయం, ఆకుపచ్చ} రంగు2: {నీలం, ఎరుపు, కాషాయం, ఆకుపచ్చ} ledlvl: {1 – 255} హోల్డ్‌ఓవర్: {నిజం, తప్పు} |
N/A | 8128(G2) 8138 8190S |
> 3.3 |
| స్ట్రోబ్ ఆపండి. | పోస్ట్ | /api/నియంత్రణలు/స్ట్రోబ్/స్టాప్ | N/A | N/A | 8128(G2) 8138 8190S |
> 3.3 |
| టోన్‌ని ఒకసారి ప్లే చేయండి లేదా దాన్ని లూప్ చేయండి. | పోస్ట్ | /api/నియంత్రణలు/టోన్/ప్రారంభం | మార్గం: {టోన్} అనగా. చిమ్.వావ్ లూప్: {true, false} లేదా {0, 1} ఉదా {“మార్గం”:”chime.wav”, “loop”: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/నియంత్రణలు/24v/ఎనేబుల్ | 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 | {“వెర్షన్”: “నవీకరించబడింది”} లేదా {"సంస్కరణ: Telugu": " ”} |
అన్నీ | > 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/నియంత్రణలు/rx/stop | N/A | N/A | అన్నీ | > 5.3.4 |
| మల్టీక్యాస్ట్ మోడ్‌ను సెట్ చేయండి. | పెట్టండి | /api/state/mcast/update/ | {“మోడ్”:”పంపినవారు”, “చిరునామా”: , “పోర్ట్”: , “రకం”:”rtp”} లేదా {“మోడ్”:”పంపినవారు”, “చిరునామా”: , “పోర్ట్”: , “రకం”:”పాలీ”, “సమూహం”:1} **గమనిక**: ఈ ఆదేశానికి ముందు నియంత్రణలు/టోన్/ప్రారంభం ఉపయోగించబడితే, టోన్ ప్రస్తుత సెట్టింగ్‌లను ఉపయోగించి ప్లే అవుతుంది web UI. |
N/A | 8301 | > 5.0 |
| JSON పేలోడ్ నుండి నిర్దిష్ట పరామితికి విలువను చొప్పించండి. | పెట్టండి | /api/సెట్టింగ్‌లు | పరామితి: {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) |
/sci/నియంత్రణలు/చేయండి లేదా/అన్‌లాక్ చేయండి | డోరిడ్: {స్థానిక, netdc1} * ఐచ్ఛికం |
8039 8028(G2) 8201 8063 |
> 3.3 |
| తలుపు లాక్. | /sci/నియంత్రణలు/చేయండి లేదా/లాక్ చేయండి | డోరిడ్: {స్థానిక, netdc1} * ఐచ్ఛికం |
8039 8028(G2) 8201 8063 |
> 3.3 |
| టోన్‌ని ఒకసారి ప్లే చేయండి లేదా దాన్ని లూప్ చేయండి. | /sci/నియంత్రణలు/నే/ప్రారంభించండి | మార్గం: {టోన్} అనగా. చిమ్.వావ్ లూప్: {true, false} లేదా {0, 1} |
అన్నీ | > 3.3 |
| స్వరం ఆపు. | /sci/నియంత్రణలు/నీ/ఆపు | N/A | అన్నీ | > 3.3 |
| కావలసిన రంగు మరియు నమూనా పారామితులతో స్ట్రోబ్‌ను సక్రియం చేయండి. | /sci/నియంత్రణలు/స్ట్రోబ్/ప్రారంభం | నమూనా: {0 – 15} రంగు1: {నీలం, ఎరుపు, కాషాయం, ఆకుపచ్చ} రంగు2: {నీలం, ఎరుపు, కాషాయం, ఆకుపచ్చ} ledlvl: {1 – 255} హోల్డ్‌ఓవర్: {true, false} |
8128(G2) 8138 8190S |
> 3.3 |
| స్ట్రోబ్ ఆపండి. | /sci/నియంత్రణలు/స్ట్రోబ్/స్టాప్ | 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 |