سرویس های خارجی External APIs

هدف از ایجاد بخش سرویس های خارجی External APIs این است که سرویس هایی که به طور دستی از backendکد نویسی شده اند ، نیز از اریکس قابل دسترسی باشند.

بدین منظور باید سرویس های خارجی به لیست سرویس های اریکس اضافه شوند. هم چنین ایجاد مجوز های دسترسی توسعه دهندگان به سرویس های دستی نیز امکان پذیر باشد .

برای درک بهتر External API بهتر است با مفاهیمی اشنا شویم که در ادامه به آن ها برخواهیم خورد.

تمامی سرویس ها توسط ادرس اختصاصیشان (URL) صدا زده می شوند.

پس ادرس یا URL سرویس های دستی نیز باید به اریکس اضافه شوند.

Root در واقع شاخه شروع یک url است .  برای مثال  newservice/switch/getbook/id=2  یک ادرس می باشد. Newservice/ شاخه شروع این url است.

همانطور که گفته شد ، سرویس های دستی سرویس هایی هستند که از اریکس ایجاد نمی شوند و به طور دستی کد زده شده اند.

 در external API قابلیتی وجود دارد که توسعه دهندگان انتخاب می کنند.سرویس های زیر مجموعه هر root به کدام API Group اختصاص یابد. بدین ترتیب دسترسی به سرویس های دستی که به عنوان external APIs شناخته می شوند، آسان تر  و سریع تر است.

یکی از دیگر قابلیت های این بخش دکمه rescan است که تمامی سرویس هایی که زیر مجموعه هر root هستند را به طور خودکار اسکن می کند.

امکان اضافه کردن به صورت دستی یک external api  از یک root نیز در این بخش وجود دارد.

در صورت اضافه شدن url های دستی به اریکس ، سرویس ها اسکن شده و می توان آن ها را به عنوان External Api اضافه کرد تا به لیست سرویس ها در permissions اضافه شوند . سپس امکان صدور مجوز و دسترسی به آن سرویس ها نیز برای نقش ها فراهم می شود.

سرویس هایی که به صورت دستی کدنویسی شده اند ابتدا باید url آن ها به root list اضافه شوند. در دکمه Add Root ،   root یک ادرس (URL) را به همراه Api group مورد نظر انتخاب می کنیم. تمامی root ها نیز امکان ویرایش و حذف را دارند.

پس از اضافه شدن root مورد نظر به  root list توسط دکمه Rescan ،  تمامی سرویس هایی که با آن root صدا زده می شوند ، به طور خودکار به اریکس اضافه خواهند شد . ازین پس به عنوان APIs  External شناخته می شوند.

دکمه add External API  نیز به منظور اضافه کردن یک سرویس به صورت دستی به اریکس قرار داده شده است.

ادرس سرویس را به طور کامل  نوشته و  root آن را از لیست انتخاب کرده و سرویس به  API Group  مورد نظر اضافه  می شود.

در صورت انتخاب چندین سرویس امکان حذف گروهی آنها توسط دکمه delete selected Apis وجود دارد.

دکمه های edit  و  delete هر سرویس ، ویرایش و حذف سرویس ها را امکانپذیر کرده است.

نکته قابل ذکر این است که در دکمه edit  می توان url یک سرویس را تغییر داد.
این امکان بدین منظور تعبیه شده که اگر برنامه نویسی از کد ،  url سرویس را تغییر داد ، بتوان در اریکس نیز ویرایش کرد تا سرویس مجدد شناخته شود.