ALGO RESTful API

د محصول معلومات: RESTful API لارښود

د Algo RESTful API کاروونکو ته اجازه ورکوي چې د HTTP/HTTPS غوښتنو له لارې د دوی په شبکه کې د الګو IP پای پایټونو ته لاسرسی ، لاسوهنه ، او حرکتونه حرکت وکړي. دا سند د بې ریاسته عملیاتو یو یونیفورم او دمخه ټاکل شوی سیټ چمتو کوي چې د الګو وسیلو سره د تعامل لپاره کارول کیدی شي. 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. مطلوب پټنوم تنظیم کړئ (ډیفالټ پاسورډ: الګو). په یاد ولرئ چې معیاري تصدیق د ډیفالټ لخوا فعال شوی.

د بنسټیز تصدیق فعالول (اختیاري)

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 د سیسټم ساتنې ټب کې ځانګړتیا.

تصدیق Sampلی کوډ

مهرباني وکړئ بریښنالیک وکړئ support@algosolutions.com که تاسو یو معیاري یا بنسټیز تصدیق غواړئampلی کوډ.
د اضافي ملاتړ لپاره، زنګ ووهئ 604-454-3792 یا بریښنالیک support@algosolutions.com

د معلوماتو خبرتیا

نوټ
یادښت ګټور تازه معلومات، معلومات او لارښوونې په ګوته کوي چې باید تعقیب شي

ردول

په دې سند کې موجود معلومات په ټولو برخو کې سم ګڼل کیږي مګر د الګو لخوا تضمین ندي. معلومات د خبرتیا پرته د بدلون تابع دي او باید په هیڅ ډول د الګو یا د هغې د کومې وابسته یا فرعي شرکتونو لخوا د ژمنې په توګه ونه کارول شي. Algo او د هغې وابسته او فرعي شرکتونه په دې سند کې د کومې تېروتنې یا نیمګړتیاو مسؤلیت په غاړه نه اخلي. د دې سند بیاکتنه یا د دې نوي نسخې ممکن د ورته بدلونونو د شاملولو لپاره صادر شي. الګو د دې لارښود یا ورته محصولاتو ، سافټویر ، فرم ویئر ، او / یا هارډویر کارولو په پایله کې د زیانونو یا ادعاګانو لپاره هیڅ مسؤلیت په غاړه نلري. د دې سند هیڅ برخه د الګو له لیکلي اجازې پرته د کومې موخې لپاره په هیڅ ډول یا په هره وسیله - بریښنایی یا میخانیکي - بیا تولید یا لیږدول کیدی نشي.
په شمالي امریکا کې د اضافي معلوماتو یا تخنیکي مرستې لپاره، مهرباني وکړئ د Algo د ملاتړ ټیم سره اړیکه ونیسئ:

د الګو تخنیکي ملاتړ
1-604-454-3792
support@algosolutions.com

©2022 Algo د Algo Communication Products Ltd یو راجستر شوی سوداګریز نښه ده.
ټول حقونه خوندي دي. نورې ټولې سوداګریزې نښې د دوی د اړوندو مالکینو ملکیت دی. ټول مشخصات پرته له خبرتیا د بدلون تابع دي.

 عمومي

پیژندنه

دا سند تشریح کوي چې څنګه د Algo RESTful API د HTTP/HTTPS غوښتنو له لارې ستاسو په شبکه کې د الګو IP پای پایټونو ته د لاسرسي ، مینځلو او حرکت کولو لپاره کارول کیدی شي ، په بیله بیا د امنیت مختلف کچو سره د تصدیق کولو څو مختلف میتودونه. د غوښتنې سیسټمونه کولی شي د الګو وسیلو سره د یونیفورم او دمخه تعریف شوي بې ریاسته عملیاتو له لارې اړیکه ونیسي چې پدې سند کې تعریف شوي. غوښتنې د سرچینې URI ته د JSON پیلوډ سره چمتو کیږي او د JSON ځواب ترلاسه کوي. HTTP/HTTPS GET، POST، او PUT غوښتنې د JSON پیلوډ سره د سرچینې URI لپاره کیږي (د تادیاتو لیست لپاره د کمانډ برخه وګورئ).

 تصدیق کول

درې ډوله تصدیقونه شتون لري:

•  معیاري (سپارښتنه)
•  بنسټیز
•  هیڅ نه (سپارښتنه نه کیږي)

معیاري تصدیق د SHA-256 کوډ شوي هضم سره د هش پراساس د پیغام تصدیق کولو کوډ (HMAC) کاروي. بنسټیز تصدیق د بیس 64 کوډ کولو څخه کار اخلي او باید یوازې د HTTPS په اړه وکارول شي. هیڅ تصدیق باید یوازې په خورا احتیاط سره ونه کارول شي ځکه چې دا هیڅ تصدیق نه وړاندې کوي. د نورو جزیاتو لپاره د تصدیق اړتیاو برخه وګورئ.

ترتیب او ترتیب

شرطونه

•  دا سند داسې انګیري چې د الګو پای ټکی د فرم ویئر نسخه 3.3 یا لوړ پرمخ وړي.
•  د غوښتنې کونکي او الګو وسیلو ترمینځ د وخت توپیر باید د معیاري تصدیق کارولو لپاره له 30 ثانیو څخه کم وي.
• ډاډ ترلاسه کړئ چې NTP (د شبکې وخت پروتوکول) کارول کیږي. د ګمرکي NTP سرورونو پته کیدای شي په پرمختللو ترتیباتو → وخت ټب کې ترتیب شي.

نوټ
مخکې ترتیب شوي NTP سرورونه په عامه توګه کوربه شوي، نو د دې لپاره د انټرنیټ اتصال اړین دی. که چیرې د انټرنیټ اتصال شتون ونلري، د محلي NTP سرور ترتیب کړئ او د هغې IP پته دننه کړئ.

• ډاډ ترلاسه کړئ چې د الګو وسیلې سیسټم وخت د سم وخت زون سره تنظیم شوی. دا د پرمختللو ترتیباتو → وخت ټب ته د نیویګ کولو له لارې ترسره کیدی شي.

 د 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 غوښتنه کې اړین سرلیکونه
> د منځپانګې ډول: "application/json"
> منځپانګه-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

واک ورکول: hmac admin:[nonce]:[hmac_output]
د اجازې سرلیکونه عبارت دي له:

1. توری 'hmac admin' وروسته د کولون ':' سره.
2. نه - یو تصادفي یا نه تکراریدونکی ارزښت، وروسته د کولون ':'.
3. Hmac_output - د RESTful API پاسورډ (پټ کیلي) لخوا رامینځته شوی چې ستاسو په وسیله او د HMAC ان پټ کې ترتیب شوی ، په لاندې ډول:
   [د غوښتنې_طريقه]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[نه]

د HMAC ننوت example: (د پټ کیلي په توګه د 'الګو' کارول)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 د SHA-256 په کارولو سره د هضم په توګه د پټنوم او HMAC ان پټ تار سره HMAC تولید کړئ
د HMAC محصول example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

نیټه: ورځ، نیټه میاشت، کال ساعت: دقیقه: ثانیه GMT
Example
نېټه: ثور، 22 سپتمبر، 2022 02:33:07 GMT
معیاري تصدیق د پایلوډ ایکس سرهampLe:

 د JSON پیلډ پرته د معیاري تصدیق غوښتنه

3.1 ته ورته د منځپانګې اړوند سرلیکونه/hmac ان پټ له مینځه وړل شوي.
HMAC داخل: [request_method]:[request_uri]:[timestamp]:[nonce] HMAC ان پټ example: (د پټ کیلي په توګه د 'الګو' کارول)
ترلاسه کړئ:/api/settings/audio.page.vol:1601312252:49936
د SHA-256 په کارولو سره د پاسورډ او HMAC ان پټ سټینګ سره HMAC تولید کړئ:
د HMAC محصول example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
معیاري تصدیق پرته د پایلوډ exampLe:

 د اصلي تصدیق غوښتنه

د تصدیق کولو دا طریقه باید په احتیاط سره وکارول شي ځکه چې دا د معیاري میتود په پرتله لږ خوندي دی.

واک ورکول: اساسی [base64]
ExampLe:
واک ورکول: بنسټیز YWRtaW46YWxnbwo=
بنسټیز تصدیق exampLe:

امرونه

 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": "بې کاره"} یا {"input.relay.status": "فعال"}	ټول محصولات د ریل ان پټ سره، پرته له 8063. لاندې وګورئ.	> 4.1
د انپټ 1 یا ان پټ 2 ترمینل حالت استخراج کړئ.	ترلاسه کړئ	/api/info/input.relay1.status or /api/info/input.relay2.status	N/A	{"input.relay1.status": "بې کاره"} یا {"input.relay1.status": "فعال"}	8063	> 4.1
د ټون لیست بیرته ترلاسه کړئ files اوس مهال نصب شوی.	ترلاسه کړئ	/api/info/tonelist	N/A	{"ټونلست":["bell-na.wav","bell uk.wav","buzzer.wav"،…]}	ټول	> 5.0
د وسیلې معلومات بیرته ترلاسه کړئ چې د وضعیت پا pageه کې ښودل شوي.	ترلاسه کړئ	/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 لوپ: {رښتیا، غلط} یا {0، 1} د مثال په توګه {"لاره":"chime.wav"، "لوپ": ریښتیا}	N/A	ويناوال ۴۵ 8373 8028(G2) 8201 8039	> 3.3
ټون بند کړئ.	پوسټ	/api/controls/tone/stop	N/A	N/A	ويناوال ۴۵ 8373 8028(G2) 8201 8039	> 3.3
د مخکینۍ ثبت شوي پیغام سره د تلیفون توسیع ته زنګ ووهئ.	پوسټ	/api/controls/call/start	{"توسیع":"2099"، "ټون":"gong.wav"، "interval":"0″، "maxdur":"10″}	N/A	ويناوال ۴۵ 8410 8420	> 3.3
زنګ ختم کړئ.	پوسټ	/api/controls/call/stop	N/A	N/A	ويناوال ۴۵ 8410 8420	> 3.3

د یو طرفه پاڼې کال پیل کړئ. وسیله به د هدف توسیع څخه آډیو جریان ترلاسه کړي.	پوسټ	/api/controls/call/page	{"توسیع":" "}	N/A	ويناوال ۴۵ 8420	> 5.3.4
د هدف پای ټکی بیا پیل کړئ.	پوسټ	/api/controls/reboot	N/A	N/A	ټول	> 3.3
دروازه خلاصه کړه. "سیمه ایز" سیمه ایز ریل کنټرولوي "netdc1" د لیرې شبکې دروازې کنټرولر کنټرولوي (8063)	پوسټ	/api/controls/door/unlock	doorid: {local, netdc1} * اختیاري	N/A	8039 8028(G2) 8201 8063	> 3.3
دروازه بنده کړه.	پوسټ	/api/controls/door/lock	doorid: {local, 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
د محصول ریل فعال کړئ.	پوسټ	/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
ملټي کاسټ حالت تنظیم کړئ.	PUT	/api/state/mcast/update/	{"موډ":"لیږونکی"، "پته": , "پورټ": , "ډول":"rtp"} یا {"موډ":"لیږونکی"، "پته": , "پورټ": , "ډول":"پولی"، "ډله":1} **یادونه**: که د دې کمانډ څخه دمخه کنټرول/ټون/سټارټ وکارول شي ، نو ټون به د اوسني تنظیماتو په کارولو سره پلی شي web UI.	N/A	8301	> 5.0
د JSON پیلوډ څخه ځانګړي پیرامیټر ته ارزښت دننه کړئ.	PUT	/api/ترتیبات	پیرامیټر: {value} د مثال په توګه {"audio.page.vol": "-3dB"}	N/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 د ساده کنټرول انٹرفیس (SCI) کمانډونه

د SCI ټول حکمونه د GET غوښتنې دي او د تصدیق لپاره "usi" او "admin" عام پیرامیټونه لري.
ExampLe:
ترلاسه کړئ http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

تفصیل	URI	اضافي پېلوډ پیرامیټونه	محصولات	FW
دروازه خلاصه کړه. "سیمه ایز" سیمه ایز ریل کنټرولوي "netdc1" د لیرې شبکې دروازې کنټرولر کنټرولوي (8063)	/sci/controls/do or/unlock	doorid: {local, netdc1} * اختیاري	8039 8028(G2) 8201 8063	> 3.3
دروازه بنده کړه.	/sci/controls/do or/lock	doorid: {local, netdc1} * اختیاري	8039 8028(G2) 8201 8063	> 3.3
یو ځل ټون غږ کړئ یا یې لوپ کړئ.	/sci/controls/to ne/start	لاره: {ټون} یعنی. chime.wav لوپ: {رښتیا، غلط} یا {0، 1}	ټول	> 3.3
ټون بند کړئ.	/sci/controls/to ne/stop	N/A	ټول	> 3.3
سټروب د مطلوب رنګ او نمونو پیرامیټونو سره فعال کړئ.	/sci/controls/strobe/start	نمونه: {0 - 15} رنګ1: {نیلي، سور، امبر، شنه} رنګ 2: {نی، سور، امبر، شنه} ledlvl: {1 – 255} holdover: {رښتیا، غلط}	8128(G2) 8138 8190S	> 3.3
سټروب بند کړئ.	/sci/controls/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

حوالې

• د کارن لارښود