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 ને સક્ષમ કરી રહ્યું છે

1. ઉપકરણમાં લૉગ ઇન કરો web ઇન્ટરફેસ અને એડવાન્સ્ડ સેટિંગ્સ એડમિન ટેબ પર નેવિગેટ કરો.
2. API સપોર્ટ વિભાગ સુધી નીચે સ્ક્રોલ કરો અને RESTful API ને સક્ષમ કરો.
3. ઇચ્છિત પાસવર્ડ સેટ કરો (ડિફોલ્ટ પાસવર્ડ: algo). નોંધ કરો કે માનક પ્રમાણીકરણ મૂળભૂત રીતે સક્ષમ છે.

મૂળભૂત પ્રમાણીકરણ સક્ષમ કરવું (વૈકલ્પિક)

1. માં web ઈન્ટરફેસ, સિસ્ટમ મેઈન્ટેનન્સ ટેબ પર નેવિગેટ કરો અને રૂપરેખાંકન ડાઉનલોડ કરો file.
2. રૂપરેખાંકન ખોલો file કોઈપણ ટેક્સ્ટ એડિટર સાથે અને નીચેની લીટી ઉમેરો: api.auth.basic = 1
3. સંશોધિત ગોઠવણી સાચવો અને અપલોડ કરો file પુનઃસ્થાપિત ગોઠવણીનો ઉપયોગ કરીને ઉપકરણ પર પાછા જાઓ File સિસ્ટમ જાળવણી ટેબમાં લક્ષણ.

કોઈ પ્રમાણીકરણ પદ્ધતિ સક્ષમ કરી રહ્યું નથી (વૈકલ્પિક)

કોઈ પ્રમાણીકરણ પદ્ધતિને સક્ષમ કરવા માટે, RESTful API પાસવર્ડ ફીલ્ડ ખાલી છોડી દો. આ પદ્ધતિની ભલામણ કરવામાં આવતી નથી અને તેનો ઉપયોગ ફક્ત પરીક્ષણ હેતુઓ માટે જ થવો જોઈએ કારણ કે તે કોઈ સુરક્ષા પ્રદાન કરતી નથી.

સરળ નિયંત્રણ ઈન્ટરફેસ સક્ષમ કરી રહ્યું છે (વૈકલ્પિક)

1. પર web ઈન્ટરફેસ, સિસ્ટમ મેઈન્ટેનન્સ ટેબ પર નેવિગેટ કરો અને રૂપરેખાંકન ડાઉનલોડ કરો file.
2. રૂપરેખાંકન ખોલો file ટેક્સ્ટ એડિટરનો ઉપયોગ કરીને અને બે લીટીઓ ઉમેરો. તમારા ઇચ્છિત પાસવર્ડમાં બદલો.
3. એડમિન.web.sci = 1
4. Sci.admin.pwd =
5. સંશોધિત ગોઠવણી સાચવો અને અપલોડ કરો file પુનઃસ્થાપિત ગોઠવણીનો ઉપયોગ કરીને ઉપકરણ પર પાછા જાઓ File સિસ્ટમ જાળવણી ટેબમાં લક્ષણ.

પ્રમાણીકરણ એસample કોડ

કૃપા કરીને ઇમેઇલ કરો support@algosolutions.com જો તમને પ્રમાણભૂત અથવા મૂળભૂત પ્રમાણીકરણ જોઈએ છેampલે કોડ.
વધારાના સમર્થન માટે, કૉલ કરો 604-454-3792 અથવા ઇમેઇલ support@algosolutions.com

માહિતી સૂચનાઓ

નોંધ
નોંધ ઉપયોગી અપડેટ્સ, માહિતી અને સૂચનાઓ સૂચવે છે જેનું પાલન કરવું જોઈએ

અસ્વીકરણ

આ દસ્તાવેજમાં સમાવિષ્ટ માહિતી તમામ બાબતોમાં સચોટ હોવાનું માનવામાં આવે છે પરંતુ Algo દ્વારા તેની ખાતરી આપવામાં આવતી નથી. માહિતી નોટિસ વિના ફેરફારને આધીન છે અને Algo અથવા તેના કોઈપણ આનુષંગિકો અથવા પેટાકંપનીઓ દ્વારા પ્રતિબદ્ધતા તરીકે કોઈપણ રીતે અર્થઘટન કરવું જોઈએ નહીં. Algo અને તેના આનુષંગિકો અને પેટાકંપનીઓ આ દસ્તાવેજમાંની કોઈપણ ભૂલો અથવા ભૂલો માટે કોઈ જવાબદારી લેતા નથી. આવા ફેરફારોને સમાવવા માટે આ દસ્તાવેજના સંશોધનો અથવા તેની નવી આવૃત્તિઓ જારી કરવામાં આવી શકે છે. Algo આ માર્ગદર્શિકા અથવા આવા ઉત્પાદનો, સોફ્ટવેર, ફર્મવેર અને/અથવા હાર્ડવેરના કોઈપણ ઉપયોગથી થતા નુકસાન અથવા દાવાઓ માટે કોઈ જવાબદારી સ્વીકારતું નથી. આ દસ્તાવેજના કોઈપણ ભાગનું પુનઃઉત્પાદન અથવા પ્રસારણ કોઈપણ સ્વરૂપમાં અથવા કોઈપણ માધ્યમથી - ઈલેક્ટ્રોનિક અથવા મિકેનિકલ - કોઈપણ હેતુ માટે Algoની લેખિત પરવાનગી વિના કરી શકાતું નથી.
ઉત્તર અમેરિકામાં વધારાની માહિતી અથવા તકનીકી સહાય માટે, કૃપા કરીને અલ્ગોની સપોર્ટ ટીમનો સંપર્ક કરો:

અલ્ગો ટેકનિકલ સપોર્ટ
1-604-454-3792
support@algosolutions.com

©2022 એલ્ગો એ એલ્ગો કોમ્યુનિકેશન પ્રોડક્ટ્સ લિ.નું નોંધાયેલ ટ્રેડમાર્ક છે.
બધા હકો અમારી પાસે રાખેલા છે. અન્ય તમામ ટ્રેડમાર્ક્સ તેમના સંબંધિત માલિકોની મિલકત છે. બધા સ્પેક્સ નોટિસ વિના બદલવાને પાત્ર છે.

 સામાન્ય

પરિચય

આ દસ્તાવેજ વર્ણવે છે કે કેવી રીતે Algo RESTful API નો ઉપયોગ HTTP/HTTPS વિનંતીઓ દ્વારા તમારા નેટવર્ક પર Algo IP એન્ડપોઇન્ટ્સ પરની ક્રિયાઓ ઍક્સેસ કરવા, ચાલાકી કરવા અને ટ્રિગર કરવા માટે તેમજ સુરક્ષાના વિવિધ સ્તરો સાથેની કેટલીક વિવિધ પ્રમાણીકરણ પદ્ધતિઓ દ્વારા કરી શકાય છે. વિનંતી કરતી સિસ્ટમો આ દસ્તાવેજમાં વ્યાખ્યાયિત સ્ટેટલેસ કામગીરીના એકસમાન અને પૂર્વવ્યાખ્યાયિત સમૂહ દ્વારા અલ્ગો ઉપકરણો સાથે ક્રિયાપ્રતિક્રિયા કરી શકે છે. JSON પેલોડ સાથે સંસાધનના URI ને વિનંતીઓ કરવામાં આવે છે અને JSON પ્રતિસાદ મેળવે છે. HTTP/HTTPS GET, POST અને PUT વિનંતીઓ JSON પેલોડ સાથે URI ને સંસાધન માટે કરવામાં આવે છે (પેલોડ્સની સૂચિ માટે આદેશ વિભાગ જુઓ).

 પ્રમાણીકરણ

ત્રણ પ્રકારના પ્રમાણીકરણ છે:

•  માનક (ભલામણ કરેલ)
•  મૂળભૂત
•  કંઈ નહીં (આગ્રહણીય નથી)

સ્ટાન્ડર્ડ ઓથેન્ટિકેશન SHA-256 એન્કોડેડ ડાયજેસ્ટ સાથે હેશ-આધારિત મેસેજ ઓથેન્ટિકેશન કોડ (HMAC) નો ઉપયોગ કરે છે. મૂળભૂત પ્રમાણીકરણ Base64 એન્કોડિંગનો ઉપયોગ કરે છે અને તેનો ઉપયોગ ફક્ત HTTPS પર થવો જોઈએ. કોઈ પ્રમાણીકરણનો ઉપયોગ અત્યંત કાળજી સાથે થવો જોઈએ કારણ કે તે કોઈ પ્રમાણીકરણ પ્રદાન કરતું નથી. વધુ વિગતો માટે પ્રમાણીકરણ આવશ્યકતાઓ વિભાગ જુઓ.

સેટઅપ અને કન્ફિગરેશન

પૂર્વજરૂરીયાતો

•  આ દસ્તાવેજ ધારે છે કે Algo એન્ડપોઇન્ટ ફર્મવેર વર્ઝન 3.3 અથવા ઉચ્ચતર ચલાવી રહ્યું છે.
•  પ્રમાણભૂત પ્રમાણીકરણનો ઉપયોગ કરવા માટે વિનંતીકર્તા અને Algo ઉપકરણો વચ્ચેનો સમય તફાવત 30 સેકન્ડ કરતાં ઓછો હોવો જોઈએ.
• ખાતરી કરો કે NTP (નેટવર્ક ટાઈમ પ્રોટોકોલ) ઉપયોગમાં છે. વૈવિધ્યપૂર્ણ NTP સર્વરના સરનામાં એડવાન્સ્ડ સેટિંગ્સ → ટાઈમ ટેબમાં ગોઠવી શકાય છે.

નોંધ
પૂર્વ-રૂપરેખાંકિત NTP સર્વર્સ સાર્વજનિક રીતે હોસ્ટ કરવામાં આવે છે, તેથી તેના સુધી પહોંચવા માટે ઇન્ટરનેટ કનેક્શન આવશ્યક છે. જો કોઈ ઇન્ટરનેટ કનેક્શન ઉપલબ્ધ ન હોય, તો સ્થાનિક NTP સર્વરને ગોઠવો અને તેનું IP સરનામું દાખલ કરો.

• ખાતરી કરો કે Algo ઉપકરણ સિસ્ટમનો સમય યોગ્ય સમય ઝોનમાં ગોઠવાયેલ છે. આ એડવાન્સ્ડ સેટિંગ્સ → ટાઈમ ટેબ પર નેવિગેટ કરીને કરી શકાય છે.

 RESTful API ને સક્ષમ કરી રહ્યું છે

1. માં લોગ ઇન કરો web ઇન્ટરફેસ અને એડવાન્સ્ડ સેટિંગ્સ → એડમિન ટેબ પર નેવિગેટ કરો.
2. API સપોર્ટ વિભાગ સુધી નીચે સ્ક્રોલ કરો, RESTful API ને સક્ષમ કરો અને પાસવર્ડને ઈચ્છા મુજબ સેટ કરો (ડિફોલ્ટ પાસવર્ડ: algo)
   નોંધ
   માનક પ્રમાણીકરણ મૂળભૂત રીતે સક્ષમ છે.

મૂળભૂત પ્રમાણીકરણ સક્ષમ કરો (વૈકલ્પિક)

1. માં web ઈન્ટરફેસ, સિસ્ટમ → જાળવણી ટેબ પર નેવિગેટ કરો અને રૂપરેખાંકન ડાઉનલોડ કરો file.
2. રૂપરેખાંકન ખોલો file કોઈપણ ટેક્સ્ટ એડિટર સાથે અને નીચેની લીટી ઉમેરો: api.auth.basic = 1
3.  સંશોધિત ગોઠવણી સાચવો અને અપલોડ કરો file પુનઃસ્થાપિત ગોઠવણીનો ઉપયોગ કરીને ઉપકરણ પર પાછા જાઓ File સિસ્ટમ → જાળવણી ટેબમાં લક્ષણ.

કોઈ પ્રમાણીકરણ પદ્ધતિ નથી (વૈકલ્પિક)

કોઈ પ્રમાણીકરણ પદ્ધતિને સક્ષમ કરવા માટે, RESTful API પાસવર્ડ ફીલ્ડ ખાલી છોડી દો. આ પદ્ધતિની ભલામણ કરવામાં આવતી નથી અને તેનો ઉપયોગ ફક્ત પરીક્ષણ હેતુઓ માટે જ થવો જોઈએ કારણ કે તે કોઈ સુરક્ષા પ્રદાન કરતી નથી.

સરળ નિયંત્રણ ઈન્ટરફેસ સક્ષમ કરી રહ્યું છે (વૈકલ્પિક)

1. પર web ઈન્ટરફેસ, સિસ્ટમ → જાળવણી ટેબ પર નેવિગેટ કરો અને રૂપરેખાંકન ડાઉનલોડ કરો file.
2.  રૂપરેખાંકન ખોલો file ટેક્સ્ટ એડિટરનો ઉપયોગ કરીને અને બે લીટીઓ ઉમેરો. બદલો તમારા ઈચ્છા પાસવર્ડ માટે. એડમિન.web.sci = 1
   Sci.admin.pwd =
3.  સંશોધિત ગોઠવણી સાચવો અને અપલોડ કરો file પુનઃસ્થાપિત ગોઠવણીનો ઉપયોગ કરીને ઉપકરણ પર પાછા જાઓ File સિસ્ટમ → જાળવણી ટેબમાં લક્ષણ.

પ્રમાણીકરણની આવશ્યકતાઓ

કૃપા કરીને ઇમેઇલ કરો support@algosolutions.com જો તમને પ્રમાણભૂત અથવા મૂળભૂત પ્રમાણીકરણ જોઈએ છેampલે કોડ.

JSON પેલોડ સાથે પ્રમાણભૂત પ્રમાણીકરણ વિનંતી

HTTP/HTTPS વિનંતીમાં જરૂરી હેડરો
> સામગ્રી-પ્રકાર: “એપ્લિકેશન/જેસન”
> સામગ્રી-MD5: [content_md5] દા.તample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

અધિકૃતતા: hmac એડમિન:[nonce]:[hmac_output]
અધિકૃતતા હેડરમાં આનો સમાવેશ થાય છે:

1. સ્ટ્રિંગ 'hmac એડમિન' પછી કોલોન ':'.
2. નોન્સ - એક રેન્ડમ અથવા બિન-પુનરાવર્તિત મૂલ્ય, જેના પછી કોલોન ':'.
3. Hmac_output - તમારા ઉપકરણ અને HMAC ઇનપુટ પર ગોઠવેલ RESTful API પાસવર્ડ (સિક્રેટ-કી) દ્વારા જનરેટ કરવામાં આવે છે, નીચે મુજબ:
   [વિનંતી_પદ્ધતિ]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[નોન્સ]

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 ઇનપુટ: [request_method]:[request_uri]:[સમયamp]:[nonce] HMAC ઇનપુટ એક્સample: ('algo' નો ઉપયોગ ગુપ્ત કી તરીકે)
મેળવો:/api/settings/audio.page.vol:1601312252:49936
SHA-256 નો ઉપયોગ કરીને પાસવર્ડ અને HMAC ઇનપુટ સ્ટ્રિંગ સાથે HMAC જનરેટ કરો:
HMAC આઉટપુટ ભૂતપૂર્વample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
પેલોડ એક્સ વગર માનક પ્રમાણીકરણampલે:

 મૂળભૂત પ્રમાણીકરણ વિનંતી

પ્રમાણીકરણની આ પદ્ધતિ સાવધાની સાથે વાપરવી જોઈએ કારણ કે તે પ્રમાણભૂત પદ્ધતિ કરતાં ઓછી સુરક્ષિત છે.

અધિકૃતતા: મૂળભૂત [base64]
Exampલે:
અધિકૃતતા: મૂળભૂત YWRtaW46YWxnbwo=
મૂળભૂત પ્રમાણીકરણ ભૂતપૂર્વampલે:

આદેશો

 RESTful API આદેશો

નીચે બધા સપોર્ટેડ API આદેશોની સૂચિ છે.

નોંધ
PUT વિનંતી બદલાય છે અથવા કાયમી સંસાધન બનાવે છે જે રીબૂટથી બચી જાય છે, જ્યારે POST વિનંતી ફક્ત વર્તમાન સત્ર માટે ઉપકરણને નિયંત્રિત કરે છે.

વર્ણન	પદ્ધતિ	યુઆરઆઈ	પેલોડ પરિમાણો	પરત 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”: “નિષ્ક્રિય”} અથવા {“input.relay.status”: “active”}	રિલે ઇનપુટ સાથેના તમામ ઉત્પાદનો, 8063 સિવાય. નીચે જુઓ.	> 4.1
ઇનપુટ 1 અથવા ઇનપુટ 2 ટર્મિનલ્સની સ્થિતિ બહાર કાઢો.	મેળવો	/api/info/input.relay1.status અથવા /api/info/input.relay2.status	N/A	{“input.relay1.status”: “નિષ્ક્રિય”} અથવા {“input.relay1.status”: “active”}	8063	> 4.1
સ્વરની સૂચિ પુનઃપ્રાપ્ત કરો files હાલમાં ઇન્સ્ટોલ કરેલું છે.	મેળવો	/api/info/tonelist	N/A	{“ટોનલિસ્ટ”:[“બેલ-ના.વાવ”,”બેલ યુકે.વાવ”,”બઝર.વાવ”,…]}	બધા	> 5.0
ઉપકરણ માહિતી પુનઃપ્રાપ્ત કરો જે સ્થિતિ પૃષ્ઠ પર પ્રદર્શિત થાય છે.	મેળવો	/api/info/status	N/A	સ્થિતિ ટૅબમાંથી માહિતીની સંપૂર્ણ સૂચિ.	બધા	> 5.4

વિશે પૃષ્ઠ પર પ્રદર્શિત થયેલ ઉત્પાદન માહિતી પુનઃપ્રાપ્ત કરો.	મેળવો	/api/info/about	N/A	વિશે ટેબ પર હાજર તમામ માહિતી.	બધા	> 5.4
ઇચ્છિત રંગ અને પેટર્ન પરિમાણો સાથે સ્ટ્રોબને સક્રિય કરો.	પોસ્ટ	/api/controls/strobe/start	પેટર્ન: {0 – 15} રંગ1: {વાદળી, લાલ, એમ્બર, લીલો} રંગ2: {વાદળી, લાલ, એમ્બર, લીલો} ledlvl: {1 – 255} હોલ્ડઓવર: {સાચું, ખોટું}	N/A	8128(G2) 8138 8190S	> 3.3
સ્ટ્રોબ રોકો.	પોસ્ટ	/api/controls/strobe/stop	N/A	N/A	8128(G2) 8138 8190S	> 3.3
એકવાર ટોન વગાડો અથવા તેને લૂપ કરો.	પોસ્ટ	/api/controls/tone/start	પાથ: {ટોન} એટલે કે. chime.wav લૂપ: {true, false} અથવા {0, 1} દા.ત. {“પાથ”:”chime.wav”, “લૂપ”:true}	N/A	સ્પીકર્સ 8301 8373 8028(G2) 8201 8039	> 3.3
સ્વર રોકો.	પોસ્ટ	/api/controls/ટોન/સ્ટોપ	N/A	N/A	સ્પીકર્સ 8301 8373 8028(G2) 8201 8039	> 3.3
પૂર્વ-રેકોર્ડ કરેલા સંદેશ સાથે ફોન એક્સ્ટેંશન પર કૉલ કરો.	પોસ્ટ	/api/controls/call/start	{"એક્સ્ટેંશન":"2099", “ટોન”:”gong.wav”, “અંતરાલ”:”0″, “maxdur”:”10″}	N/A	સ્પીકર્સ 8301 8410 8420	> 3.3
કૉલ સમાપ્ત કરો.	પોસ્ટ	/api/controls/call/stop	N/A	N/A	સ્પીકર્સ 8301 8410 8420	> 3.3

વન-વે પેજ કૉલ શરૂ કરો. ઉપકરણ લક્ષ્ય એક્સ્ટેંશનમાંથી ઓડિયો સ્ટ્રીમ પ્રાપ્ત કરશે.	પોસ્ટ	/api/controls/call/page	{"એક્સ્ટેંશન":" ”}	N/A	સ્પીકર્સ 8410 8420	> 5.3.4
લક્ષ્ય અંતિમ બિંદુ રીબુટ કરો.	પોસ્ટ	/api/controls/reboot	N/A	N/A	બધા	> 3.3
દરવાજો ખોલો. "સ્થાનિક" સ્થાનિક રિલેને નિયંત્રિત કરે છે "netdc1" રિમોટ નેટવર્ક ડોર કંટ્રોલરને નિયંત્રિત કરે છે (8063)	પોસ્ટ	/api/controls/door/unlock	doorid: {સ્થાનિક, netdc1} *વૈકલ્પિક	N/A	8039 8028(G2) 8201 8063	> 3.3
બારણાને તાળુ મારી દે.	પોસ્ટ	/api/controls/door/lock	doorid: {સ્થાનિક, netdc1} *વૈકલ્પિક	N/A	8039 8028(G2) 8201 8063	> 3.3
24v aux આઉટ રિલેને સક્ષમ કરો.	પોસ્ટ	api/controls/24v/enable	N/A	N/A	8063	> 5.0
24v aux આઉટ રિલેને અક્ષમ કરો.	પોસ્ટ	api/controls/24v/disable	N/A	N/A	8063	> 5.0
આઉટપુટ રિલે સક્ષમ કરો.	પોસ્ટ	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
આઉટપુટ રિલેને અક્ષમ કરો.	પોસ્ટ	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
નવીનતમ ફર્મવેર સંસ્કરણ માટે અલ્ગોનું ફર્મવેર સર્વર તપાસો.	પોસ્ટ	/api/controls/upgrade/check	N/A	{"સંસ્કરણ": "અપડેટ કરેલ"} અથવા {"સંસ્કરણ": " ”}	બધા	> 4.1
નવીનતમ ફર્મવેર સંસ્કરણ માટે અલ્ગોનું ફર્મવેર સર્વર તપાસો અને તે સંસ્કરણ પર અપગ્રેડ કરો.	પોસ્ટ	/api/controls/upgrade/start	N/A	{"સ્થિતિ": "અપડેટ કરેલ"} અથવા {"સ્ટેટસ": "અપગ્રેડિંગ ", "url”: url>} અથવા {"સ્થિતિ": " ”}	બધા	> 4.1
સ્ક્રીન પર છબી અથવા પેટર્ન પ્રદર્શિત કરો.	પોસ્ટ	/api/controls/screen/start	જુઓ નીચે	N/A	8410 8420	> 5.3.4
સ્ક્રીન પેટર્ન રોકો અને ડિફોલ્ટ સ્ક્રીન પર પાછા ફરો.	પોસ્ટ	/api/controls/screen/stop	N/A	N/A	8410 8420	> 5.3.4

મુખ્ય એપ્લિકેશન પુનઃપ્રારંભ કરો.	પોસ્ટ	/api/controls/reload	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
મલ્ટિકાસ્ટ મોડ સેટ કરો.	મૂકો	/api/state/mcast/update/	{"મોડ":"પ્રેષક", "સરનામું": , "પોર્ટ": , “પ્રકાર”:”rtp”} અથવા {“મોડ”:”પ્રેષક”, “સરનામું”: , "પોર્ટ": , “પ્રકાર”:”પોલી”, “જૂથ”:1} **નોંધ**: જો આ આદેશ પહેલાં કંટ્રોલ્સ/ટોન/સ્ટાર્ટનો ઉપયોગ કરવામાં આવે, તો ટોન વર્તમાન સેટિંગ્સનો ઉપયોગ કરીને વગાડશે web UI	N/A	8301	> 5.0
JSON પેલોડમાંથી ચોક્કસ પરિમાણમાં મૂલ્ય દાખલ કરો.	મૂકો	/api/સેટિંગ્સ	પરિમાણ: {મૂલ્ય} દા.ત. {“audio.page.vol”: “-3dB”}	N/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 સરળ નિયંત્રણ ઈન્ટરફેસ (SCI) આદેશો

બધા SCI આદેશો GET વિનંતીઓ છે અને પ્રમાણીકરણ માટે સામાન્ય પરિમાણો "usi" અને "એડમિન" ધરાવે છે.
Exampલે:
http મેળવો:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

વર્ણન	યુઆરઆઈ	વધારાના પેલોડ પરિમાણો	ઉત્પાદનો	FW
દરવાજો ખોલો. "સ્થાનિક" સ્થાનિક રિલેને નિયંત્રિત કરે છે "netdc1" રિમોટ નેટવર્ક ડોર કંટ્રોલરને નિયંત્રિત કરે છે (8063)	/sci/controls/do or/unlock	doorid: {સ્થાનિક, netdc1} *વૈકલ્પિક	8039 8028(G2) 8201 8063	> 3.3
બારણાને તાળુ મારી દે.	/sci/controls/do અથવા/lock	doorid: {સ્થાનિક, 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	N/A	બધા	> 3.3
ઇચ્છિત રંગ અને પેટર્ન પરિમાણો સાથે સ્ટ્રોબને સક્રિય કરો.	/sci/controls/strobe/start	પેટર્ન: {0 – 15} રંગ1: {વાદળી, લાલ, એમ્બર, લીલો} રંગ2: {વાદળી, લાલ, એમ્બર, લીલો} ledlvl: {1 – 255} હોલ્ડઓવર: {true, false}	8128(G2) 8138 8190S	> 3.3
સ્ટ્રોબ રોકો.	/sci/controls/strobe/stop	N/A	8128(G2) 8138 8190S	> 3.3

દસ્તાવેજો / સંસાધનો

	ALGO RESTful API [પીડીએફ] વપરાશકર્તા માર્ગદર્શિકા AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [પીડીએફ] વપરાશકર્તા માર્ગદર્શિકા AL061-GU-CP000API-230717, RESTful API, RESTful, API

સંદર્ભો

• વપરાશકર્તા માર્ગદર્શિકા