کلید 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 صورت میگیرد.
این سرویس به صورت کامل بر پایهی معماری RESTful پیاده سازی شده و از سرعت بالایی برخوردار است.
همچنین برای استفادهی هرچه راحتتر نمونه کدهای از پیش آماده شده برای زبانهای برنامهنویسی php ، جاوا (اندروید) و c# (.netcore) قرار داده شده است. تا تنها با کپی کردن آن در پروژه خود بتوانید از ارسال پیامک از طریق کلید api استفاده کنید.
هنگامی که در کنسول ثبت نام خود را تکمیل کردید، در بخش تنظیمات میتوانید کلید api خود را مشاهده نمایید. این کلید با نام کاربری و رمز عبور پنل کاربری شما در سامانه ملی پیامک ارتباط مستقیم داشته و در صورت تغییر آن، کلید api شما نیز در کنسول فاقد اعتبار خواهد بود.
با استفاده از این کلید api در بخش دیدهبان در کنسول ملی پیامک نیز لاگهای دریافتی مربوط به خطاهای ایجاد شده در هنگام استفاده از api به همراه آدر IP کاربران قرار داده شده است.
با استفاده از بخش دیدهبان برطرف کردن مشکلات پیش آمده به راحتترین شکل ممکن قابل پیگیری بوده و در صورت عدم رفع مشکل نیز میتوانید با ارسال تیکت به واحد پشتیبانی خطاهای پیش آمده را پیگیری فرمایید.
جمعبندی
برای ارسال پیامک از طریق کلید api، سامانه ملی پیامک سرویس کنسول را پیشنهاد میدهد، این سرویس بر پایهی معماری REST بوده و در کمترین زمان ممکن پیادهسازی api در پروژهی شما را ممکن میسازد.
کنسول ملی پیامک با دارا بودن api token هم امنیت ارتباط با وب سرویس را تضمین میکند و هم پیچیدگی ارسال درخواست به وب سرویس را کاهش میدهد.
رستم نژاد
سلام ممنون از مقاله های خوبتون بسیار کامل و جامع هستند کاملا مشخص هست تیم محتوا نویس اشراف زیادی به مباحث فنی دارند خدا قوت بهتون
عباسی
سلام وقتتون بخیر ما یه پنلی از شما میخوایم که هم بتونیم از وب سرویسش استفاده کنیم و هم بتونیم باهاش پیامک تبلیغاتی ارسال کنیم بار این موارد میتونیم یک پل داشته باشیم یا باید برای هر مورد یک پنل جدا تهیه کنیم؟
ممنون از پاسخگویی
سینا جعفری
سلام دوست عزیز.
شما با تهیه تنها یک پنل (پنل اقتصادی یا بالاتر) میتوانید هم برای استفاده از وبسرویس و هم ارسال پیامکهای تبلیغاتی اقدام فرمایید.
در صورت نیاز به مشاوره بیشتر میتوانید با شماره تماس 02163404 تماس حاصل فرمایید
امیرمحمد بزمانی
وبسرویستون که رفته روی api key خیلی بهتر شده دیگه نیاز نیست تیو برنامه نویسی همه چی رو بهش معرفی کنی
ممنونم که به فکر هستید
سینا جعفری
ممنون از شما.
سرویس جدید سامانه ملی پیامک با نام کنسول ملی پیامک در دست بروز رسانی هست و بزودی با امکانات جدید قابل استفاده خواهد بود
بوکا
سلام خسته نباشین
واقعا خیلی کاربردی و خوبه و اینطوری با خیال راحت پنل پیامکی تهیه میکنیم بدون اینکه نگران لو رفتن اطلاعات پنل باشیم
دیگه چی بهتر از این؟؟؟؟
سینا جعفری
ممنون از شما.
محسن نخعی
سلام وقت بخیر
با این کنسول میشه به همه شماره ها پیامک ارسال کرد؟
یا ارسال شماره محدود هستش و به یه سری از افراد خاص باید ارسال کرد و میشه منطقه بندی کرد ارسال پیامک ها رو ؟؟
یه جوری شخصی سازی ایجاد بشه؟
مرسی از راهنمایتون
سینا جعفری
سلام دوست گرامی
با استفاده از کنسول ملی پیامک قابلیت ارسال به تمامی شمارهها (حتی لیست سیاه مخابرات) را خواهید داشت.
ارسال پیامک در سرویس کنسول ملی پیامک شامل محدودیت نیست و در هر درخواست میتوانید به تعداد شماره دلخواه ارسال پیامک داشته باشید.
اما هنور امکان ارسال پیامک بر اساس منطقه بندی در این سرویس وجود ندارد. در آپدیتهای بعدی این درخواست در لیست دستور کار تیم توسعه قرار خواهد گرفت
علیرضا آقا پور
بنده خودم برنامه نویس نیستم و یکی دیگه داره کار های سایت رو انجام میده به ما گفته که از ملی پیامک پنل تهیه کنیم و دسترسی کنسول رو براش بفرستیم برای تهیه کنسول باید از کدوم قسمت اقدام به خرید کنیم؟
سینا جعفری
برای استفاه از کنسول ملی پیامک و یا وبسرویس قدیمی سامانه ملی پیامک، تهیه پنل مشابه میباشد و از بخش ثبت نام در هدر سایت میتوانید به تهیه پنل اقدام فرمایید.
اما در نظر داشته باشید که پنل پایه در سامانه ملی پیامک دارای امکان api نمیباشد.
صراف سرخ
برای باشگاه مشتریان هم میشه از وب سرویس پیامکی شما به جهت ارسال انبوه به مشتریانمون استفاده کنیم؟
سپاس از راهنمایی
سینا جعفری
سلام.
بله. برای ارسال انبوه هم میتوان از کنسول ملی پیامک و متد ارسال پیشرفته استفاده نمود.
امیر محمدی نژاد
سلام وقت بخیر
من پنل پیامکی شما رو چند سال پیش خریداری کردم نمی دونم الان برای تمدید پنل از کدام بخش باید اقدام کنم لطفا راهنمایی بفرماید ممنون از شما
سینا جعفری
سلام دوست عزیز
وقت شما هم بخیر باشه، برای تمدید پنل، کافیه که 60درصد هزینه اولیه پنلتون رو از قسمت {شارژ حساب} در داخل سامانه پرداخت بفرمایید و بعدش از طریق تماس با پشتیبانی 02163404 یا ارسال تیکت، درخواست تمدید پنل رو داشته باشید.
البته که پیشنهاد میکنم اگه فراموش کردین که پنل شما کدومه، حتماً با پشتیبانان ملی پیامک 02163404 در ارتباط باشید تا به صورت دقیق راهنماییتون کنند.
خداوردي
سلام وقتتون ٢سوال داشتم يكي اينكه براي استفاده از كنسول كدام پنل را بايد خريداري كرد و همينطور استفاده از كنسول خط خدماتي داره روي امكاناتش يا بايد خودمان خطمان را خدماتي كنيم؟
سینا جعفری
سلام دوست گرامی
برای استفاده از کنسول میتوانید پنل اقتصادی یا پنلهای بالاتر را تهیه فرمایید که قابلیت استفاده از api را دارند.
در کنسول ملی پیامک استفاده از خط خدماتی اشتراکی (یا همان سرویس ارسال پیامک از طریق پترن ) :https://www.melipayamak.com/blog/posts/sms-with-pattern-mode/ قرار داده شده است.
در صورتیکه دارای خط خدماتی اختصاصی بر روی پنل کاربری خود هستید نیز امکان استفاده از آن نیز وجود دارد.
محمد احمدی
بنده خودم برنامه نویس هستم این مورد که شما طراحی کردید واقعا عالی هستش و کار رو خیلی راحت تر میکنه. سوالی که من داشتم اینه که شما توی کنسول متد خط خدماتی اشتراکی هم ثبت کردید که دیگه از github استفاده نکنم.
سینا جعفری
سلام.
بله. دیگر نیازی به استفاده از کدها و package های گیت هاب وجود ندارد و میتوانید از کدهای آماده موجود در کنسول ملی پیامک استفاده فرمایید
دارندی
سلام و عرض ادب
ازتون پنل دارم ولی گفتید api key ارائه نمیدید ولی افزونه من میخواد این رو
باید چیکار کنم؟
سینا جعفری
با سلام
برای استفاده از وبسرویس در افزونهها باید در نظر داشته باشید که توسعه دهنده افزونه از یکی از روشهای موجود در api سامانه ملی پیامک استفاده نموده است.
بصورت پیشفرض از api سامانه ملی پیامک در افزونههای قدیمی استفاده نمیگردد و باید از نام کاربری و رمز عبور در افزونه خود استفاده نمایید.
زیرا api key ارائه شده در کنسول ملی پیامک به تنهایی قابل استفاده بوده و دیگر نیازی به استفاده از رمز عبور نخواهد بود. اگر افزونه شما تنها و تنها نیاز به api key داشته و نیازی به رمز عبور ندارد میتوانید از سرویس کنسول استفاده نمایید
زهرا شفیعی
سلام خسته نباشین
میخواستم بدونم از این کنسول برای همه برنامه و سایت ها استفاده کرد؟
من حسابدار یک شرکت هستم و میخوام برای برنامه سپیدار از این کنسول استفاده کنم
مرسی که انقدر امکانات خوب برامون فراهم میکنید
سینا جعفری
با سلام
کنسول ملی محدودیتی در زمینه استفاده ندارد. در تمامی فریمورکها و زبانهای برنامه نویسی که قابلیت استفاده از api را داشته باشند میتوان از کنسول استفاده نمود.
کریم عابدی
سلام من برای استفاده و متصل کردن پیامک به هلو میخواستم از سرویس شما استفاده کنم
خب یه سری اطلاعات رو تو این مقاله تون خوندم میخواستم بدونم که ایا ارسال برای همه شماره ها انجام می شود؟ ایا سرعت ارسال سرویس های شما متفاوت است؟
ایمان عمادی
سلام وقتتون بخیر
برای اتصال نرمافزار هلو به پنل اس ام اس، مقاله آموزش اتصال نرم افزار حسابداری هلو به سامانه پیامکی رو مطالعه بفرمایید و برای اینکه پیامکهای شما به همه ارسال بشه، راه حلش ارسال پیامک بر اساس پترن (الگو) هستش!
سرعت ارسال همه سرویسها یا پنلها یکسان و بسیار بالا هستند.
سحر صبوری
سلام وقت بخیر
خیلی مقاله جالب و مختصر و مفید بود و حتما حتما مقاله کنسول هم در آینده مطالعه خواهم کرد و به دوستان معرفی میکنم
موفق و پیروز باشید
علیرضا سیفی
سلام وقتتون بخیر و شادی باشه ممنون از مقاله ی خوبتون
این مورد روی همه ی پنل هاتون فعال است ؟ و زمانی که ما پنل نمایندگی خریداری کنیم ایا در اختیار کاربران ما نیز قرار می گیرد یا خیر ؟
سینا جعفری
با سلام
کنسول ملی پیامک بر روی پنل اقتصادی و بالاتر قابل استفاده میباشد. زیرا این پنلها دارای سرویس api میباشند.
در صورتیکه نمایندگان بخواهند بصورت مستقیم از این سرویس استفاده کنند، محدودیتی وجود ندارد. اما سرویس کنسول ملی پیامک قابلیت ریبرند سازی را دارا نمیباشد.
غمخوار
چطوری میتونم دسترسی به کنسول داشته باشم؟
منظورتان همین پنل پیامکیست؟
ممنون میشم راهنمایی بفرمایید
سینا جعفری
سلام، وقت بخیر دوست عزیز
ویدیو آموزشی کنسول ملی پیامک در همین مقاله بارگذاری شده و بصورت کامل توضیحات را ارائه میدهد.
برای دسترسی به کنسول ملی پیامک میتوانید از لینک زیر استفاده کنید.
https://console.melipayamak.com/auth/login
رعنا سادات
سلام وقت بخیر من برای هلو میخواستم از سرویس شما استفاده کنم شرایط به چه صورت هستش؟
ایا ارسال با سرعت انجام میشه؟ برای همه شمارها میره پیامک؟
ممنون میشم راهنمایی بفرمایید
سینا جعفری
سلام
سرویس کنسول ملی پیامک برای نرم افزار هلو قابل استفاده نمیباشد.
پیاده سازی انجام شده در نرم افزار هلو برای سرویس معمولی ملی پیامک میباشد که از نام کاربری و رمز عبور استفاده میکند
طاهری
سلام برای استفاده از این کنسول ما باید از شما چه پنلی رو تهیه کنیم و که این امکان رو داخلش داشته باشه؟
و سوال بعدی پنل های شما مدت زماندار هستند؟
ایمان عمادی
سلام روز بخیر
حداقل پنل اقتصادی که امکان اتصال به وبسرویس و api رو داشته باشه!
پنل اس ام اس ملی پیامک، به صورت سالیانه ارائه میشه و هزینه تمدید پنلها هم دارای 40 یا 50 درصد تخفیف هستند.
mr.kamali
سلام خسته نباشین
من از کاربران قدیمی ملی پیامک هستم و به تازگی از این سرویس مطلع شدم
فقط سوالی که هست آیا کنسول ملی پیامک وب سرویی خدماتی رو هم پشتیبانی میکنه یا خیر؟
سپاس
سینا جعفری
با سلام.
بله. در کنسول ملی پیامک متد “ارسال از خط خدماتی” برای ارسال پیامک به لیست سیاه مخابرات (یا همان سرویس ارسال پیامک از طریق پترن میباشد)
جمشیدی
ممنون از مقاله ی خوبتون می خواستم بدونم این مواردی که توضیح دادید روی همه ی پنل هاتون فعال است یا فرق میکنه چه پنلی رو خریداری کنیم ممنون مییشم در این خصوص بنده را راهنمایی بفرمایید
سینا جعفری
با سلام.
سرویس کنسول در همهی پنل های ارائه شده در سامانه ملی پیامک به جز پنل پایه قابل استفاده میباشد
عبدالله مقدم
سلام
من اگر نخوام پنل خریداری کنم میتونم برای تست وب سرویس کنسول ملی پیامک داشته باشم؟
اگر براتون مقدوره خواهش میکنم شرایط ان رااعلام بفرمایید؟
سینا جعفری
احتراما برای این مورد با واحد پشتیبانی سامانه ملی 02163404 تماس حاصل فرمایید.
پوریا رستم زاده
آیا میشه افزونه های شما هم از همین کلید api استفاده بکنه چون دیگه مشکل رمز و نام کاربری نداریم. ولی اگر خودمون یه افزونه بزنیم که از کلید api استفاده کنه میتونیم از کنسول استفاده کنیم.
سینا جعفری
با سلام.
برای تغییر افزونههای ارائه شده در سامانه ملی پیامک برنامه مدونی ایجاد شده است و در آینده نزدیک پلاگینهایی که قابلیت انتقال به کنسول ملی پیامک را داشته باشند، بروز رسانی خواهند شد
حسام میرحسینی
سلام
چطور میتونم به کنسول ملی پیامک دسترسی داشته باشم؟
بنده پنل پیامکی شمارو دارم
ممنون میشم توضبحات ارائه بفرمایید.
سینا جعفری
با سلام
احتراما از لینک زیر وارد صفحه کنسول شوید:
https://console.melipayamak.com/auth/login
همچنین ویدیو آموزشی و راهنمای کنسول ملی پیامک نیز در این مقاله قرار داده شده است
الهام نیا
سلام روزتون بخیر واقعا این کنسول، خیلی خوبه
کار ما برنامه نویس ها رو راحت کردید
دمتون گررررم
سامان
سلام وقتتون بخیر ممنون از شما مقاله کامل و خوبی بود همچنین ویدئوی آموزشی تون خیلی کمک کننده بود من سایتم رو با php بالا آوردم و توضیحی که در مورد کنسول ملی پیامک آوردین برام جالب بود . می خوام از این امکان استفاده کنم کدوم یکی از پنل ها تون امکان کنسول رو داره ؟
سینا جعفری
با سلام خدمت شما دوست گرامی
برای استفاده از کنسول ملی پیامک میتوانید از پنل اقتصادی یا بالاتر استفاده نمایید.
در پنل پایه امکان استفاده از کنسول موجود نمیباشد.
برای راهنمایی در مورد تهیه پنل پیامکی مورد نظر خود میتوانید با پشتیبانی ملی پیامک (021-63404) تمای حاصل فرمایید
رازقیان
سلام وقتتون بخیر من از شما پنل پیامکی دارم پنل اقتصادی ایا در همین پنل ما میتونیم دسترسی به کنسول ملی پیامک رو داشته باشیم یا باید پنلمون رو تغییر بدیم؟
ممنون از پاسخگوییتون
سینا جعفری
سلام دوست عزیز
پنل اقتصادی قابلیت استفاده از کنسول را دارا میباشد و نیازی به ارتقا پنل ندارید
جعفری
ببخشید من میخوام پیامک تبلیغاتی بفرستم
یعنی همیشه باید از این api استفاده کنم؟ بلد نیستم من و نیاز به آموزش تخصصی داره؟
سینا جعفری
برای ارسال پیامک تبلیغاتی و آموزش دقیق انجام آن (چه از پنل کاربری پیامکی و یا چه از طریق api) میتوانید با واحد پشتیبانی سامانه ملی پیامک 02163404 تماس حاصل فرمایید تا راهنمایی لازم ارائه شود.
نیما یاری
درود بر شما من برای صرافی میخواستم از پنل شما استفاده کنم و برای مشتری های ثابتمون قیمت ارز رو ارسال کنم
چه مدارکی نیاز هستش برای این نوع پیامک ها؟
ایا برای همه شماره ها ارسال انجام میشه؟
سینا جعفری
سلام و درود بر شما
برای این مورد لطفاً با همکاران واحد فروش ملی پیامک 02163404 تماس بگیرید.
پیشنهاد میکنم صفحه مقررات و قوانین ملی پیامک (https://www.melipayamak.com/rules/) رو هم مطالعه بفرمایین!