DNN API End Point
 

کلمه API مخفف Application Programming Interface می باشد که به رابط کاربردی برنامه نویسی اطلاق می شود.

تعریف مختصری از API

اگر شما هر گونه تجربه ای در برنامه نویسی داشته باشید، همه معانی و مخفف ها با شنیدن کلمه Interface به ذهنتان می آید؛ اما ما بیشتر علاقمند به دانستن معنی کلاسیک و معمولی آن هستیم. یک رابط (Interface) یک مرز مشترک بین دو سیستم و سرویس جدا است. از جمله می توان این موضوع را برداشت کرد که بین این دو سیستم ارتباط برقرار است. یک API رابط پیاده سازی توسط نرم افزار است که به دیگر برنامه ها اجازه می دهد با آن ارتباط داشته باشند. یکی از مهم ترین  ارتباط ها بین وب سایت و اپلیکشن موبایل است.

REST چیست ؟

REST مخفف Representational State Transfer استREST  فقط یک سری از دستور العمل ها و سبک های معماری است که برای انتقال داده ها استفاده می شوند. این عموما در مورد اپلیکیشن های تحت وب کاربرد دارد ولی می تواند داده ها را به سایر اپلیکشن ها نیز ارسال کند

معماری REST لازم است شرایط زیر را داشته باشند:

• کلاینت سرور (client-server) باشد.
• بدون حالت (stateless) باشد.
• قابلیت cache داشته باشد.
• سیستم لایه‌بندی شده داشته باشد.
• واسط یکنواخت داشته باشد.
• دارای قابلیت کد در صورت نیاز باشد

یک وب سرویس REST دارای مشخصات زیر است :

•  بوسیله URI کار میکند .
• اطلاعات را به صورت عموما JSON دریافت میکند البته میتواند اطلاعات به صورت XML هم برگردانده شود.
• برخلاف وب سرویس های برپایه SOAP هیچ استاندارد رسمی برای وب سرویس های REST وجود ندارد به دلیل اینکه REST یک معماری است در حالی که SOAP یک پروتکل وب سرویس است.

حالا بر طبق این معماری و اصول , شرکت شارپ ماژول DNN API Endpoint تولید و طراحی کرده که بدون یک خط کد نویسی در دی ان ان می توان REST API ایجاد کرد!

امکانات ماژول

ماژول API Endpoint یک چارچوب مناسب ، قدرتمند و بسیار آسان برای سرویس دهی به برنامه های کاربردی خارج از دی ان ان (وب ، موبایل، اپلیکیشن های تحت وب و غیره ) با استفاده از REST API می باشد.

برای مثال یک وب سایت فروشگاه طراحی کرده اید و لازم است اپ موبایل آن را نیز تولید کنید و این کار استلزام به داشتن یک سرویس در سایت مربوطه می باشد تا از طریق موبایل درخواست ها به سایت ارسال شود و نتیجه مجدد دریافت گردد. این روش به راحتی با ایجاد یک متد جدید در ماژول قابل پیاده سازی می باشد.

ویژگی های ماژول:
 

لیستی از اکشن های قابل تنظیم:

آدرس هایی تولید می کنید که با فراخوانی آن لیستی از اکشن های مورد نظر شما اجرا می شود.

DNN RESTful APIs:

به راحتی می توانید با برنامه های بیرونی با RESTful APIs  ارتباط برقرار کرده و سرویس دهی کنید.

فریم وورک قابل گسترش:

می توانید اکشن های سفارشی ( Custom Action ) برای خود بسازید و در ماژول استفاده کنید.

ایجاد بینهایت متد RESTful APIs

داشتن آدرس های یونیک برای هر APIs

فعال یا غیر فعال کردن APIs

ایجاد لیستی از پارامترهای ورودی به URL به صورت متنی یا عددی

متدهای قابل استفاده  HTTP:

• GET
• POST
• PUT
• DELETE
• PATCH
• COPY
• HEAD
• OPTIONS
• LINK
• UNLINK
• PURGE
• LOCK
• UNLOCK
• PROPFIND

تولید API Keys برای دسترسی به متدها

فعال کردن ModuleID  برای دسترسی به متدها

تنظیم کردن امنیت و سطح دسترسی به متدها به صورت:

• عمومی
• فقط دامنه های مرتبط با پورتال فعلی
• تمام دامنه های ثبت شده
• لیست دامنه های سفارشی

دارای بخش تست متدهای تولید شده و مشاهده خروجی

قابلیت ترکیب شدن با ماژول My Token

برگشت مقادیر به صورت JSON

لیستی از پرکاربردترین اکشن های ماژول API Endpoint:

ثبت نام کاربر جدید

لاگین کاربر

آپدیت پروفایل کاربر

افزودن نقش به کاربر

رمزنگاری و رمزگشایی AES و RSA

ارسال ایمیل

کپی از فایل

حذف فایل

اجرای دستورات SQL

ارسال درخواست به یک سرور دیگر

و چندین اکشن کاربردی  دیگر ...

چند نمونه عکس از محیط ماژول