کلید api یکی از ابزارهای استفاده از وب سرویس میباشد. در این مقاله سعی داریم تا ارسال پیامک از طریق کلید api را شرح دهیم.
Application Programming Interface که به اختصار API نامیده میشود، یک رابط برنامه نویسی است که با استفاده از آن پیچیدگی پیادهسازی بخشهایی از پروژهی شما حذف خواهد شد.
به عبارت دیگر با استفاده از سرویسهایی که از قبل پیادهسازی شده است (API)، شما دیگر نیازی به ساخت آن سرویس از صفر نخواهید داشت و تنها با استفاده از چند خط کدنویسی پروژهی شما به آن سرویس مسلح خواهد شد.
وبسایتت رو به پیامک مجهز کن!
در سامانه ملی پیامک نیز امکان استفاده از وب سرویس با استفاده از کلید api فراهم شده و در اختیار کاربران قرار گرفته است. در ادامه بصورت کامل این سرویس شرح داده خواهد شد، اما پیشنهاد میکنم ویدئوی ارسال پیامک وبسرویس از طریق APIKey را مشاهده کنید.
API چیست؟
قبل از اینکه به سراغ کلید api برویم، باید بدانیم که API دقیقا چیست؟ با ذکر یک مثال api را توضیح خواهم داد تا درک این مورد برای شما میسر گردد.
فرض کنید شما وارد یک رستوران شدهاید، یک میز را انتخاب میکنید و مشغول بررسی فهرست رستوران میشوید. تمامی موارد موجود در فهرست در آشپرخانه رستوران آماده و قابل ارائه میباشد. اما درخواست شما به یک نحوی باید به اطلاع آشپرخانه رستوران برسد، تا سفارش شما آماده شده و بر روی میز شما قرار گیرد. در این مثال، پیشخدمت رستوران که سفارش را از شما دریافت کرده و به آشپرخانه رستوران ارائه میدهد و در ادامه پاسخ درخواست یا سفارش شما را از آشپزخانه دریافت کرده و به شما تحویل میدهد، یک api خواهد بود.
شما قصد میل کردن یک غذای دلخواه را دارید، بجای اینکه خودتان دستبهکار شوید و صفر تا صد آن وعده را آماده کنید، تنها با پرداخت هزینه و چند درخواست ساده در کمترین زمان غذای دلخواه شما برایتان آماده خواهد شد. در این مثال آشپزخانه را یک سرور (یا ارائه دهنده یک سرویس خاص) در نظر بگیرید.
شما که در حال سفارش غذا هستید بعنوان کلاینت (یا درخواست کننده آن سرویس) میباشید و پیشخدمت رستوران نیز api میباشد که زحمت را شما را کم کرده، درخواست شما را دریافت کرده و به سرویس دهنده موردنظر ارجاع میدهد، و نتیجه درخواست یا سفارش شما را به شما تحویل میدهد.
Web API یا وب سرویس چیست؟
حال که با واژهی api آشنا شدیم، به سراغ وب سرویس یا web api میرویم.
تفاوت web api و api در این است، که web api برای اجرا نیاز به شبکه جهانی یا اینترنت دارد.
web api را به این شکل در نظر بگیرید:
شما میخواهید امکان یا ویژگیای به پروژه برنامهنویسی خود اضافه کنید (بعنوان مثال ارسال پیامک کد تأیید یا استفاده از نقشه گوگل) وقتی ویژگی مورد نیاز شما از قبل در یک وب سرویس پیادهسازی شده و در کنار آن web api نیز ارائه شود،
دیگر نیاز نیست که شما صفر تا صد آن سرویس خاص را خودتان پیاده سازی کنید، به راحتی با استفاده از api ایجاد شده توسط شرکت ارائه دهنده سرویس، میتوانید به هدف خود برسید.
کلید api چیست؟
کلید api یا همان api token یک رشتهای از کاراکتر است که در فراخوانی سرویس به همراه مابقی پارامترهای مورد نیاز از سمت کاربر (یا کلاینت) به وب سرویس ارسال میشود. اما کلید api که به صورت عمومی در سامانههای پیامکی معرفی میشود، دقیقا در تعریف api key قرار نمیگیرد. آنچه در اصل بعنوان کلید api در سرویسهای پیامکی مورد استفاده قرار میگیرد، کلید احراز هویت میباشد.
این کلید در اصل برای شناسایی و احراز هویت کاربرانی که در حال استفاده از web api میباشند به کار برده میشود. اما کلید api برای شناسایی و احراز هویت پروژههایی (اپلیکیشنها، نرم افزارها و ...) که از وب سرویس استفاده میکنند به کار گرفته میشود. بعنوان مثال با استفاده از کلید api میتوان دسترسی تلفنهای همراه که دارای سیستم عامل اندروید باشند، به وب سرویس را ممنوع کرد.
کلید احراز هویت در مرحله اول مشخص میکند که کاربر مورد نظر امکان دسترسی به وب سرویس را دارا میباشد یا خیر. پس از اینکه هویت کاربر احراز شود در مرحلهی بعدی دسترسی کاربر به متدهای وب سرویس مورد بررسی قرار خواهد گرفت.
تا به اینجای کار، ما تفاوت کلید api و کلید احراز هویت را عنوان کردیم و مشخص شد آنچه که به عنوان کلید api مورد استفاده قرار میگیرد در واقع همان کلید احراز هویت میباشد. اما از آنجایی که واژهی کلید api بصورت عمومی برای کلید احراز هویت استفاده میشود، ما نیز در این مقاله از همین واژه استفاده میکنیم.
استفاده از کلید api در وب سرویس ملی پیامک
احراز هویت برای استفاده از وب سرویس در سامانه ملی پیامک به دو صورت انجام میشود.
- نام کاربری و رمز عبور: هنگامی که شما در سامانه ملی پیامک ثبتنام خود میکنید، به شما یک نام کاربری و رمز عبور تعلق میگیرد که با استفاده از آن میتوانید وارد پنل کاربری پیامکی شده و همچنین در وب سرویس از آن استفاده کنید. برای مشاهده مستندات اینجا کلیک کنید.
- استفاده از کلید api (کنسول ملی پیامک) : در کنسول ملی پیامک میتوان با استفاده از کلید api ایجاد شده برای هر حساب کاربری در سامانه ملی پیامک، از web api استفاده نمود.
کنسول ملی پیامک
سامانه ملی پیامک به منظور افزایش امنیت و همچنین تسهیل استفاده از وب سرویس این سامانه، سرویس جدیدی به نام کنسول را ایجاد کرده و در اختیار کابران خود قرار داده است.
برای آشنایی کامل با این سرویس میتوانید مقاله آموزشی کنسول ملی پیامک را مطالعه فرمایید که در صفحه مربوطه ویدیو آموزشی نیز قرار داده شده است.
در این سرویس شما دیگر نیازی به استفاده از نام کاربری و رمز عبور خود ندارید و ارسال درخواستها و همچنین احراز هویت کاربران با استفاده از کلید api صورت میگیرد.
با استفاده از این کلید api در بخش دیدهبان در کنسول ملی پیامک نیز لاگهای دریافتی مربوط به خطاهای ایجاد شده در هنگام استفاده از api به همراه آدر IP کاربران قرار داده شده است.
با استفاده از بخش دیدهبان برطرف کردن مشکلات پیش آمده به راحتترین شکل ممکن قابل پیگیری بوده و در صورت عدم رفع مشکل نیز میتوانید با ارسال تیکت به واحد پشتیبانی خطاهای پیش آمده را پیگیری فرمایید.
جمعبندی
برای ارسال پیامک از طریق کلید api، سامانه ملی پیامک سرویس کنسول را پیشنهاد میدهد، این سرویس بر پایهی معماری REST بوده و در کمترین زمان ممکن پیادهسازی api در پروژهی شما را ممکن میسازد.
کنسول ملی پیامک با دارا بودن api token هم امنیت ارتباط با وب سرویس را تضمین میکند و هم پیچیدگی ارسال درخواست به وب سرویس را کاهش میدهد.
نیما یاری
درود بر شما من برای صرافی میخواستم از پنل شما استفاده کنم و برای مشتری های ثابتمون قیمت ارز رو ارسال کنم
چه مدارکی نیاز هستش برای این نوع پیامک ها؟
ایا برای همه شماره ها ارسال انجام میشه؟
جعفری
ببخشید من میخوام پیامک تبلیغاتی بفرستم
یعنی همیشه باید از این api استفاده کنم؟ بلد نیستم من و نیاز به آموزش تخصصی داره؟
رازقیان
سلام وقتتون بخیر من از شما پنل پیامکی دارم پنل اقتصادی ایا در همین پنل ما میتونیم دسترسی به کنسول ملی پیامک رو داشته باشیم یا باید پنلمون رو تغییر بدیم؟
ممنون از پاسخگوییتون
سامان
سلام وقتتون بخیر ممنون از شما مقاله کامل و خوبی بود همچنین ویدئوی آموزشی تون خیلی کمک کننده بود من سایتم رو با php بالا آوردم و توضیحی که در مورد کنسول ملی پیامک آوردین برام جالب بود . می خوام از این امکان استفاده کنم کدوم یکی از پنل ها تون امکان کنسول رو داره ؟
الهام نیا
سلام روزتون بخیر واقعا این کنسول، خیلی خوبه
کار ما برنامه نویس ها رو راحت کردید
دمتون گررررم
حسام میرحسینی
سلام
چطور میتونم به کنسول ملی پیامک دسترسی داشته باشم؟
بنده پنل پیامکی شمارو دارم
ممنون میشم توضبحات ارائه بفرمایید.
پوریا رستم زاده
آیا میشه افزونه های شما هم از همین کلید api استفاده بکنه چون دیگه مشکل رمز و نام کاربری نداریم. ولی اگر خودمون یه افزونه بزنیم که از کلید api استفاده کنه میتونیم از کنسول استفاده کنیم.
عبدالله مقدم
سلام
من اگر نخوام پنل خریداری کنم میتونم برای تست وب سرویس کنسول ملی پیامک داشته باشم؟
اگر براتون مقدوره خواهش میکنم شرایط ان رااعلام بفرمایید؟
جمشیدی
ممنون از مقاله ی خوبتون می خواستم بدونم این مواردی که توضیح دادید روی همه ی پنل هاتون فعال است یا فرق میکنه چه پنلی رو خریداری کنیم ممنون مییشم در این خصوص بنده را راهنمایی بفرمایید
mr.kamali
سلام خسته نباشین
من از کاربران قدیمی ملی پیامک هستم و به تازگی از این سرویس مطلع شدم
فقط سوالی که هست آیا کنسول ملی پیامک وب سرویی خدماتی رو هم پشتیبانی میکنه یا خیر؟
سپاس