ALGO RESTful API

ഉൽപ്പന്ന വിവരം: RESTful API ഗൈഡ്

Algo RESTful API ഉപയോക്താക്കളെ HTTP/HTTPS അഭ്യർത്ഥനകളിലൂടെ അവരുടെ നെറ്റ്‌വർക്കിലെ Algo IP എൻഡ്‌പോയിന്റുകളിൽ ആക്‌സസ് ചെയ്യാനും കൈകാര്യം ചെയ്യാനും പ്രവർത്തനങ്ങളെ ട്രിഗർ ചെയ്യാനും അനുവദിക്കുന്നു. ഈ പ്രമാണം ആൽഗോ ഉപകരണങ്ങളുമായി സംവദിക്കാൻ ഉപയോഗിക്കാവുന്ന ഏകീകൃതവും മുൻകൂട്ടി നിർവചിക്കപ്പെട്ടതുമായ സ്‌റ്റേറ്റ്‌ലെസ് പ്രവർത്തനങ്ങളുടെ ഒരു കൂട്ടം നൽകുന്നു. JSON പേലോഡുകളുള്ള HTTP/HTTPS GET, POST, PUT അഭ്യർത്ഥനകളെ API പിന്തുണയ്ക്കുന്നു.

പ്രാമാണീകരണം

Algo RESTful API-യിൽ മൂന്ന് തരം പ്രാമാണീകരണങ്ങൾ ലഭ്യമാണ്:

• സ്റ്റാൻഡേർഡ് ആധികാരികത (സ്ഥിരസ്ഥിതിയായി പ്രവർത്തനക്ഷമമാക്കി)
• അടിസ്ഥാന പ്രാമാണീകരണം (ഓപ്ഷണൽ)
• പ്രാമാണീകരണ രീതിയില്ല (ശുപാർശ ചെയ്തിട്ടില്ല; പരിശോധനാ ആവശ്യങ്ങൾക്ക് മാത്രം)

ഉൽപ്പന്ന ഉപയോഗ നിർദ്ദേശങ്ങൾ: RESTful API

മുൻവ്യവസ്ഥകൾ

RESTful API പ്രവർത്തനക്ഷമമാക്കുന്നതിന് മുമ്പ്, മുൻകൂട്ടി കോൺഫിഗർ ചെയ്‌ത NTP സെർവറുകളിൽ എത്താൻ ഉപകരണത്തിന് ഇന്റർനെറ്റ് കണക്ഷൻ ഉണ്ടെന്ന് ഉറപ്പാക്കുക. ഇന്റർനെറ്റ് കണക്ഷൻ ലഭ്യമല്ലെങ്കിൽ, ഒരു പ്രാദേശിക NTP സെർവർ കോൺഫിഗർ ചെയ്‌ത് അതിന്റെ IP വിലാസം നൽകുക.

RESTful API പ്രവർത്തനക്ഷമമാക്കുന്നു

1. ഉപകരണത്തിലേക്ക് ലോഗിൻ ചെയ്യുക web ഇന്റർഫേസ് ചെയ്ത് വിപുലമായ ക്രമീകരണ അഡ്മിൻ ടാബിലേക്ക് നാവിഗേറ്റ് ചെയ്യുക.
2. API പിന്തുണ വിഭാഗത്തിലേക്ക് താഴേക്ക് സ്ക്രോൾ ചെയ്ത് RESTful API പ്രവർത്തനക്ഷമമാക്കുക.
3. ആവശ്യമുള്ള പാസ്‌വേഡ് സജ്ജമാക്കുക (സ്ഥിര പാസ്‌വേഡ്: അൽഗോ). സ്ഥിരസ്ഥിതി പ്രാമാണീകരണം പ്രവർത്തനക്ഷമമാക്കിയിട്ടുണ്ടെന്ന കാര്യം ശ്രദ്ധിക്കുക.

അടിസ്ഥാന പ്രാമാണീകരണം പ്രവർത്തനക്ഷമമാക്കുന്നു (ഓപ്ഷണൽ)

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 നിങ്ങൾക്ക് ഒരു സ്റ്റാൻഡേർഡ് അല്ലെങ്കിൽ അടിസ്ഥാന പ്രാമാണീകരണം വേണമെങ്കിൽ sampകോഡ്.
അധിക പിന്തുണയ്‌ക്ക്, വിളിക്കുക 604-454-3792 അല്ലെങ്കിൽ ഇമെയിൽ support@algosolutions.com

വിവര അറിയിപ്പുകൾ

കുറിപ്പ്
ഉപയോഗപ്രദമായ അപ്‌ഡേറ്റുകളും വിവരങ്ങളും പിന്തുടരേണ്ട നിർദ്ദേശങ്ങളും കുറിപ്പ് സൂചിപ്പിക്കുന്നു

നിരാകരണം

ഈ ഡോക്യുമെന്റിൽ അടങ്ങിയിരിക്കുന്ന വിവരങ്ങൾ എല്ലാ അർത്ഥത്തിലും കൃത്യമാണെന്ന് വിശ്വസിക്കപ്പെടുന്നു, പക്ഷേ അത് ആൽഗോയ്ക്ക് ഉറപ്പുനൽകുന്നില്ല. അറിയിപ്പ് കൂടാതെ വിവരങ്ങൾ മാറ്റത്തിന് വിധേയമാണ്, ആൽഗോ അല്ലെങ്കിൽ അതിന്റെ ഏതെങ്കിലും അഫിലിയേറ്റുകളുടെയോ അനുബന്ധ സ്ഥാപനങ്ങളുടെയോ പ്രതിബദ്ധതയായി ഇത് ഒരു തരത്തിലും വ്യാഖ്യാനിക്കാൻ പാടില്ല. ആൽഗോയും അതിന്റെ അനുബന്ധ സ്ഥാപനങ്ങളും അനുബന്ധ സ്ഥാപനങ്ങളും ഈ ഡോക്യുമെന്റിലെ എന്തെങ്കിലും പിശകുകൾക്കോ ​​ഒഴിവാക്കലുകൾക്കോ ​​ഒരു ഉത്തരവാദിത്തവും ഏറ്റെടുക്കുന്നില്ല. അത്തരം മാറ്റങ്ങൾ ഉൾപ്പെടുത്തുന്നതിനായി ഈ പ്രമാണത്തിന്റെ പുനരവലോകനങ്ങളോ അതിന്റെ പുതിയ പതിപ്പുകളോ നൽകാവുന്നതാണ്. ഈ മാനുവൽ അല്ലെങ്കിൽ അത്തരം ഉൽപ്പന്നങ്ങൾ, സോഫ്‌റ്റ്‌വെയർ, ഫേംവെയർ, കൂടാതെ/അല്ലെങ്കിൽ ഹാർഡ്‌വെയർ എന്നിവയുടെ ഏതെങ്കിലും ഉപയോഗത്തിന്റെ ഫലമായുണ്ടാകുന്ന കേടുപാടുകൾക്കോ ​​ക്ലെയിമുകൾക്കോ ​​ആൽഗോ ഒരു ബാധ്യതയും വഹിക്കുന്നില്ല. ആൽഗോയിൽ നിന്നുള്ള രേഖാമൂലമുള്ള അനുമതിയില്ലാതെ ഈ ഡോക്യുമെന്റിന്റെ ഒരു ഭാഗവും ഏതെങ്കിലും രൂപത്തിൽ അല്ലെങ്കിൽ ഏതെങ്കിലും വിധത്തിൽ - ഇലക്ട്രോണിക് അല്ലെങ്കിൽ മെക്കാനിക്കൽ - പുനർനിർമ്മിക്കാനോ കൈമാറ്റം ചെയ്യാനോ കഴിയില്ല.
വടക്കേ അമേരിക്കയിലെ കൂടുതൽ വിവരങ്ങൾക്കും സാങ്കേതിക സഹായത്തിനും, ദയവായി അൽഗോയുടെ പിന്തുണാ ടീമിനെ ബന്ധപ്പെടുക:

ആൽഗോ സാങ്കേതിക പിന്തുണ
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 വഴി മാത്രമേ ഉപയോഗിക്കാവൂ. ആധികാരികത നൽകാത്തതിനാൽ അതീവ ശ്രദ്ധയോടെ മാത്രമേ ആധികാരികത ഉപയോഗിക്കാവൂ. കൂടുതൽ വിവരങ്ങൾക്ക് ആധികാരികത ആവശ്യകതകൾ വിഭാഗം കാണുക.

സജ്ജീകരണവും കോൺഫിഗറേഷനും

മുൻവ്യവസ്ഥകൾ

•  Algo എൻഡ്‌പോയിന്റ് ഫേംവെയർ പതിപ്പ് 3.3 അല്ലെങ്കിൽ അതിലും ഉയർന്നത് പ്രവർത്തിക്കുന്നുവെന്ന് ഈ പ്രമാണം അനുമാനിക്കുന്നു.
•  സ്റ്റാൻഡേർഡ് പ്രാമാണീകരണം ഉപയോഗിക്കുന്നതിന് അപേക്ഷകനും ആൽഗോ ഉപകരണങ്ങളും തമ്മിലുള്ള സമയ വ്യത്യാസം 30 സെക്കൻഡിൽ കുറവായിരിക്കണം.
• NTP (നെറ്റ്‌വർക്ക് ടൈം പ്രോട്ടോക്കോൾ) ഉപയോഗത്തിലുണ്ടെന്ന് ഉറപ്പാക്കുക. ഇഷ്‌ടാനുസൃത NTP സെർവറുകളുടെ വിലാസങ്ങൾ വിപുലമായ ക്രമീകരണങ്ങൾ → സമയ ടാബിൽ കോൺഫിഗർ ചെയ്‌തേക്കാം.

കുറിപ്പ്
മുൻകൂട്ടി ക്രമീകരിച്ച NTP സെർവറുകൾ പൊതുവായി ഹോസ്റ്റ് ചെയ്‌തിരിക്കുന്നു, അതിനാൽ അതിൽ എത്തിച്ചേരാൻ ഇന്റർനെറ്റ് കണക്ഷൻ ആവശ്യമാണ്. ഇന്റർനെറ്റ് കണക്ഷൻ ലഭ്യമല്ലെങ്കിൽ, ഒരു പ്രാദേശിക NTP സെർവർ കോൺഫിഗർ ചെയ്‌ത് അതിന്റെ IP വിലാസം നൽകുക.

• Algo ഉപകരണ സിസ്റ്റം സമയം ശരിയായ സമയ മേഖലയിലേക്ക് ക്രമീകരിച്ചിട്ടുണ്ടെന്ന് ഉറപ്പാക്കുക. വിപുലമായ ക്രമീകരണങ്ങൾ → ടൈം ടാബിലേക്ക് നാവിഗേറ്റ് ചെയ്യുന്നതിലൂടെ ഇത് ചെയ്യാൻ കഴിയും.

 RESTful API പ്രവർത്തനക്ഷമമാക്കുന്നു

1. ലോഗിൻ ചെയ്യുക web ഇന്റർഫേസ് ചെയ്ത് വിപുലമായ ക്രമീകരണങ്ങൾ → അഡ്മിൻ ടാബിലേക്ക് നാവിഗേറ്റ് ചെയ്യുക.
2. API പിന്തുണാ വിഭാഗത്തിലേക്ക് താഴേക്ക് സ്ക്രോൾ ചെയ്യുക, RESTful API പ്രവർത്തനക്ഷമമാക്കുകയും പാസ്‌വേഡ് ഇഷ്ടാനുസരണം സജ്ജമാക്കുകയും ചെയ്യുക (സ്ഥിര പാസ്‌വേഡ്: അൽഗോ)
   കുറിപ്പ്
   സ്റ്റാൻഡേർഡ് പ്രാമാണീകരണം സ്ഥിരസ്ഥിതിയായി പ്രവർത്തനക്ഷമമാക്കിയിരിക്കുന്നു.

അടിസ്ഥാന പ്രാമാണീകരണം പ്രവർത്തനക്ഷമമാക്കുക (ഓപ്ഷണൽ)

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 നിങ്ങൾക്ക് ഒരു സ്റ്റാൻഡേർഡ് അല്ലെങ്കിൽ അടിസ്ഥാന പ്രാമാണീകരണം വേണമെങ്കിൽ sampകോഡ്.

ഒരു JSON പേലോഡിനൊപ്പം സ്റ്റാൻഡേർഡ് പ്രാമാണീകരണ അഭ്യർത്ഥന

HTTP/HTTPS അഭ്യർത്ഥനയിൽ ആവശ്യമായ തലക്കെട്ടുകൾ
> ഉള്ളടക്ക തരം: "അപ്ലിക്കേഷൻ/json"
> ഉള്ളടക്കം-MD5: [content_md5] ഉദാample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

അംഗീകാരം: hmac അഡ്മിൻ:[nonce]:[hmac_output]
അംഗീകാര തലക്കെട്ടുകളിൽ ഇവ ഉൾപ്പെടുന്നു:

1. 'hmac അഡ്‌മിൻ' എന്ന സ്‌ട്രിംഗിന് ശേഷം ഒരു കോളൻ ':'.
2. നോൻസ് - ക്രമരഹിതമായ അല്ലെങ്കിൽ ആവർത്തിക്കാത്ത മൂല്യം, തുടർന്ന് കോളൻ ':'.
3. Hmac_output - നിങ്ങളുടെ ഉപകരണത്തിലും HMAC ഇൻപുട്ടിലും കോൺഫിഗർ ചെയ്‌തിരിക്കുന്ന RESTful API പാസ്‌വേഡ് (രഹസ്യ-കീ) വഴി ജനറേറ്റുചെയ്‌തത്, ചുവടെ:
   [request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[ഒരിക്കലും]

HMAC ഇൻപുട്ട് മുൻample: (രഹസ്യ കീയായി 'ആൽഗോ' ഉപയോഗിക്കുന്നു)
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
പേലോഡ് ഉള്ള സ്റ്റാൻഡേർഡ് ആധികാരികത മുൻampLe:

 JSON പേലോഡ് ഇല്ലാതെ സ്റ്റാൻഡേർഡ് പ്രാമാണീകരണ അഭ്യർത്ഥന

ഉള്ളടക്കവുമായി ബന്ധപ്പെട്ട തലക്കെട്ടുകൾ/hmac ഇൻപുട്ട് ഒഴിവാക്കിയ 3.1-ന് സമാനമാണ്.
HMAC ഇൻപുട്ട്: [request_method]:[request_uri]:[timestamp]:[nonce] HMAC ഇൻപുട്ട് മുൻample: (രഹസ്യ കീയായി 'ആൽഗോ' ഉപയോഗിക്കുന്നു)
GET:/api/settings/audio.page.vol:1601312252:49936
SHA-256 ഉപയോഗിച്ച് പാസ്‌വേഡും HMAC ഇൻപുട്ട് സ്‌ട്രിംഗും ഉപയോഗിച്ച് HMAC സൃഷ്‌ടിക്കുക:
HMAC ഔട്ട്പുട്ട് മുൻample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
പേലോഡ് ഇല്ലാത്ത സ്റ്റാൻഡേർഡ് ആധികാരികത മുൻampLe:

 അടിസ്ഥാന പ്രാമാണീകരണ അഭ്യർത്ഥന

സ്റ്റാൻഡേർഡ് രീതിയേക്കാൾ സുരക്ഷിതമല്ലാത്തതിനാൽ ഈ പ്രാമാണീകരണ രീതി ശ്രദ്ധയോടെ ഉപയോഗിക്കണം.

അംഗീകാരം: അടിസ്ഥാന [base64]
ExampLe:
അംഗീകാരം: അടിസ്ഥാന YWRtaW46YWxnbwo=
അടിസ്ഥാന പ്രാമാണീകരണം ഉദാampLe:

കമാൻഡുകൾ

 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
ആവശ്യമുള്ള നിറവും പാറ്റേൺ പാരാമീറ്ററുകളും ഉപയോഗിച്ച് സ്ട്രോബ് സജീവമാക്കുക.	പോസ്റ്റ്	/എപിഐ/നിയന്ത്രണങ്ങൾ/സ്ട്രോബ്/ആരംഭിക്കുക	പാറ്റേൺ: {0 – 15} നിറം1: {നീല, ചുവപ്പ്, ആമ്പർ, പച്ച} നിറം2: {നീല, ചുവപ്പ്, ആമ്പർ, പച്ച} ledlvl: {1 – 255} ഹോൾഡോവർ: {ശരി, തെറ്റ്}	N/A	8128(G2) 8138 8190 എസ്	> 3.3
സ്ട്രോബ് നിർത്തുക.	പോസ്റ്റ്	/എപിഐ/നിയന്ത്രണങ്ങൾ/സ്ട്രോബ്/സ്റ്റോപ്പ്	N/A	N/A	8128(G2) 8138 8190 എസ്	> 3.3
ഒരിക്കൽ ഒരു ടോൺ പ്ലേ ചെയ്യുക അല്ലെങ്കിൽ ലൂപ്പ് ചെയ്യുക.	പോസ്റ്റ്	/api/നിയന്ത്രണങ്ങൾ/ടോൺ/ആരംഭിക്കുക	പാത: {tone} അതായത്. മണിനാദം.wav ലൂപ്പ്: {true, false} അല്ലെങ്കിൽ {0, 1} ഉദാ {“പാത്ത്”:”chime.wav”, “ലൂപ്പ്”:ട്രൂ}	N/A	സ്പീക്കറുകൾ 8301 8373 8028(G2) 8201 8039	> 3.3
ടോൺ നിർത്തുക.	പോസ്റ്റ്	/എപിഐ/നിയന്ത്രണങ്ങൾ/ടോൺ/സ്റ്റോപ്പ്	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/controls/reboot	N/A	N/A	എല്ലാം	> 3.3
വാതിൽ തുറക്കുക. "ലോക്കൽ" ലോക്കൽ റിലേ നിയന്ത്രിക്കുന്നു "netdc1" റിമോട്ട് നെറ്റ്‌വർക്ക് ഡോർ കൺട്രോളറിനെ നിയന്ത്രിക്കുന്നു (8063)	പോസ്റ്റ്	/api/നിയന്ത്രണങ്ങൾ/വാതിൽ/അൺലോക്ക്	ഡോറിഡ്: {ലോക്കൽ, netdc1} * ഓപ്ഷണൽ	N/A	8039 8028(G2) 8201 8063	> 3.3
വാതില് പൂട്ടൂ.	പോസ്റ്റ്	/എപിഐ/നിയന്ത്രണങ്ങൾ/ഡോർ/ലോക്ക്	ഡോറിഡ്: {ലോക്കൽ, netdc1} * ഓപ്ഷണൽ	N/A	8039 8028(G2) 8201 8063	> 3.3
24v ഓക്സ് ഔട്ട് റിലേ പ്രവർത്തനക്ഷമമാക്കുക.	പോസ്റ്റ്	api/controls/24v/enable	N/A	N/A	8063	> 5.0
24v ഓക്സ് ഔട്ട് റിലേ പ്രവർത്തനരഹിതമാക്കുക.	പോസ്റ്റ്	api/controls/24v/disable	N/A	N/A	8063	> 5.0
ഔട്ട്പുട്ട് റിലേ പ്രവർത്തനക്ഷമമാക്കുക.	പോസ്റ്റ്	/എപിഐ/നിയന്ത്രണങ്ങൾ/റിലേ/പ്രാപ്തമാക്കുക	N/A	N/A	8063	> 5.0
ഔട്ട്പുട്ട് റിലേ പ്രവർത്തനരഹിതമാക്കുക.	പോസ്റ്റ്	/api/നിയന്ത്രണങ്ങൾ/റിലേ/പ്രവർത്തനരഹിതമാക്കുക	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/നിയന്ത്രണങ്ങൾ/സ്ക്രീൻ/ആരംഭിക്കുക	കാണുക താഴെ	N/A	8410 8420	> 5.3.4
സ്‌ക്രീൻ പാറ്റേൺ നിർത്തി ഡിഫോൾട്ട് സ്‌ക്രീനിലേക്ക് മടങ്ങുക.	പോസ്റ്റ്	/എപിഐ/നിയന്ത്രണങ്ങൾ/സ്ക്രീൻ/സ്റ്റോപ്പ്	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
മൾട്ടികാസ്റ്റ് മോഡ് സജ്ജമാക്കുക.	പുട്ട്	/api/state/mcast/update/	{“മോഡ്”:”അയക്കുന്നയാൾ”, “വിലാസം”: , "പോർട്ട്": , “തരം”:”rtp”} അല്ലെങ്കിൽ {“മോഡ്”:”അയക്കുന്നയാൾ”, “വിലാസം”: , "പോർട്ട്": , “തരം”:”പോളി”, “ഗ്രൂപ്പ്”:1} **ശ്രദ്ധിക്കുക**: ഈ കമാൻഡിന് മുമ്പ് നിയന്ത്രണങ്ങൾ/ടോൺ/ആരംഭം ഉപയോഗിക്കുകയാണെങ്കിൽ, നിലവിലെ ക്രമീകരണങ്ങൾ ഉപയോഗിച്ച് ടോൺ പ്ലേ ചെയ്യും web യുഐ.	N/A	8301	> 5.0
JSON പേലോഡിൽ നിന്ന് ഒരു നിർദ്ദിഷ്ട പാരാമീറ്ററിലേക്ക് ഒരു മൂല്യം ചേർക്കുക.	പുട്ട്	/api/ക്രമീകരണങ്ങൾ	പരാമീറ്റർ: {value} ഉദാ {“audio.page.vol”: “-3dB”}	N/A	8180(G2) 8186 8190 8190 എസ് 8301 8373	> 3.3

 ലളിതമായ നിയന്ത്രണ ഇന്റർഫേസ് (എസ്‌സി‌ഐ) കമാൻഡുകൾ

എല്ലാ SCI കമാൻഡുകളും GET അഭ്യർത്ഥനകളാണ് കൂടാതെ പ്രാമാണീകരണത്തിനായി പൊതുവായ പാരാമീറ്ററുകൾ "usi", "admin" എന്നിവയുണ്ട്.
ExampLe:
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
ഒരിക്കൽ ഒരു ടോൺ പ്ലേ ചെയ്യുക അല്ലെങ്കിൽ ലൂപ്പ് ചെയ്യുക.	/ശാസ്ത്രം/നിയന്ത്രണങ്ങൾ/ആരംഭിക്കുക	പാത: {tone} അതായത്. മണിനാദം.wav ലൂപ്പ്: {true, false} അല്ലെങ്കിൽ {0, 1}	എല്ലാം	> 3.3
ടോൺ നിർത്തുക.	/ശാസ്ത്രം/നിയന്ത്രണങ്ങൾ/ഇനി/നിർത്തുക	N/A	എല്ലാം	> 3.3
ആവശ്യമുള്ള നിറവും പാറ്റേൺ പാരാമീറ്ററുകളും ഉപയോഗിച്ച് സ്ട്രോബ് സജീവമാക്കുക.	/ശാസ്ത്രം/നിയന്ത്രണങ്ങൾ/സ്ട്രോബ്/ആരംഭിക്കുക	പാറ്റേൺ: {0 – 15} നിറം1: {നീല, ചുവപ്പ്, ആമ്പർ, പച്ച} നിറം2: {നീല, ചുവപ്പ്, ആമ്പർ, പച്ച} ledlvl: {1 – 255} ഹോൾഡോവർ: {true, false}	8128(G2) 8138 8190 എസ്	> 3.3
സ്ട്രോബ് നിർത്തുക.	/ശാസ്ത്രം/നിയന്ത്രണങ്ങൾ/സ്ട്രോബ്/സ്റ്റോപ്പ്	N/A	8128(G2) 8138 8190 എസ്	> 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

റഫറൻസുകൾ

• ഉപയോക്തൃ മാനുവൽ