Application Programming Interface یا همان API برای Integrate یا اتصال برنامه های مختلف و تسهیل اشتراک داده ها بین آنها استفاده می شود. این اتصال را می توان با برنامه های دیگر یا Web Service هایی که قادر به ارسال داده ها از طریق پروتکل HTTP هستند، برقرار کرد.
دو کاربرد اصلی API در سرویس دسک:
- Integration: اتصال برنامه های دیگر به ServiceDesk Plus
- Development: به واسطه Custom Trigger میتوانیم قابلیت های خود برنامه سرویس دسک را نیز ارتقا بخشیم.
الف) Integration
با استفاده از API، از طریق سایر برنامه ها یا Web Serviceها می‌توان در ServiceDesk Plus یک سری اقدامات را انجام داد. از این طریق میتوانیم در ServiceDesk Plus بدون ورود به برنامه مستقیما یک درخواست ایجاد کنیم.
برای درک لزوم استفاده از API در سرویس دسک، فرض کنید یک ابزار نظارت بر شبکه (مانند PRTG یا Solarwinds) بر روی سرور شما نصب و در حال مانیتور کردن شبکه شماست. اگر از اخطار ایمیلی استفاده کنیم، هنگامی که یک خطا در شبکه توسط ابزار نظارت بر شبکه شناسایی می شود، یک Notification ایمیلی به عنوان درخواست برای ServiceDesk Plus ارسال می شود. مقادیر فیلد (اولویت، سطح، تأثیر، دسته و غیره) را نیز از طریق Email Command می‌توان بصورت پیشفرض در ServiceDesk Plus تعیین کرد.
با استفاده از REST API می توانید این فرآیند را اتوماتیک کنید. در این حالت هنگامی که یک خطا در شبکه شناسایی می شود، ابزار مانیتورینگ شبکه جزئیات خطا را ارزیابی کرده و بطور خودکار درخواست را از طریق پروتکل HTTP در ServiceDesk Plus ثبت می کند. مقدار شناسه درخواست یا Request ID نیز برای انجام اقدامات بیشتر در صورت نیاز به مانیتورینگ بازگشت داده می شود.
وقتی درخواست حل می‌شود، ServiceDesk Plus میتواند یک URL بازگشتی یا Callback URL را فراخوانی کند که توسط مانیتورینگ ارائه شده است. این کار به مانیتورینگ نشان می دهد که درخواست حل شده است. مانیتورینگ نیز بر اساس پیکربندی خود میتواند اخطاری که برای این خطا ایجاد کرده را ببندد.
هر اقدام با API بر اساس پارامتر بوده و از طریق پروتکل HTTP با متد POST به آدرس URL ارسال می شود. قالب آدرس URL به شرح زیر است:
http://<servername>:<port number>/api/v3/<module>
احراز هویت به برنامه ServiceDesk Plus مبتنی بر کلید API مربوط به کارشناس است. یعنی یک کلید API همراه با آدرس اینترنتی برای هر عملیات ارسال می شود.
با API چه اقداماتی می‌توان انجام داد؟
REST API در سرویس دسک از اقدامات زیر پشتیبانی می‌کند:
- اقدامات مختلف در درخواست شامل:
- افزودن درخواست جدید
- برداشتن یا Pickup کردن درخواست
- انتساب درخواست ها
- افزودن فایل پیوست
- و افزودن یا ویرایش راهکار
- ویرایش، بستن، حذف یا مشاهده درخواست های موجود
- افزودن یادداشت‌های جدید به یک درخواست و یا ویرایش، حذف و مشاهده یادداشت‌های موجود در یک درخواست
- اضافه کردن Worklog به یک درخواست و یا ویرایش، حذف و مشاهده Worklog های موجود
- افرودن فایل پیوست به یک درخواست
- افزودن، ویرایش و یا دریافت یک راهکار در یک درخواست
- پاسخ به درخواست
- انجام اقدامات مربوط به کارشناسان شامل Import کردن یک کارشناس
- انجام اقدامات مربوط به درخواست کنندگان شامل Import کردن درخواست کننده‌گان
- انجام اقدامات مربوط به ادمین شامل:
- وارد کردن دسته‌بندی
- وارد کردن دسته‌بندی فرعی
- وارد کردن موارد
- وارد کردن سطح
- وارد کردن وضعیت
- وارد کردن فوریت
- وارد کردن اولویت
- وارد کردن الگوی درخواست
- وارد کردن گروه پشتیبانی
ب) Development
چگونگی کار با API
Documentation یا اسناد این موضوع در سمت برنامه سرویس دسک در مسیر زیر در دسترس است.
Admin >> Genaral Setting >> API >> Documentaion
در قسمت Documentation توضیحات لازم در خصوص تمامی اعمال قابل اجرا و Attribute ها و پارامترهای مورد نیاز در API ارائه شده است. میتوانیم با ویرایش کد JSON در Input data و کلیک بر روی دکمه Try Now صحت عملکرد درخواست را تست کرده و پاسخ دریافتی را در کادر Sample Response Body مشاهده کنیم.
