بروزرسانی: 01 تیر 1404
SMS.ir وب سرویس RESTful
وب سرویس RESTful یا REST (مخفف عبارت Representational State Transfer) یک سبک معماری و مجموعه دستورالعمل هایی است که برای انتقال داده ها استفاده می شود. در معماری REST، به جای استفاده از روش های پیچیده مانند SOAP، از HTTP ساده برای اتصال دو سیستم (کلاینت-سرور) استفاده می شود.
نرم افزارهای مبتنی بر این معماری را اپلیکیشن RESTful می نامند. API های RESTful در واقع API هایی هستند که از معماری REST استفاده می کنند.
مزایای وب سرویس RESTful
در واقع یکی از مزایای REST دسترسی مشتریان به منابع از طریق درخواست های HTTP است. درخواست ها را می توان با استفاده از روش های مختلف ارسال کرد. این روش ها عبارتند از GET، POST، PUT، DELETE، ...
روش GET برای بازیابی و خواندن منبع
روش POST برای ایجاد یک منبع جدید
روش های PUT و PATCH برای ویرایش یا بازنویسی یک منبع
روش DELETE برای حذف یک منبع
از دیگر مزایای REST می توان به سرعت آن اشاره کرد، زیرا بدون ویژگی های سخت افزاری SOAP، REST از منابع کمتری استفاده می کند.
ما می توانیم یک وب سرویس RESTful را به هر زبان برنامه نویسی بنویسیم و آن را روی هر پلتفرمی که می خواهیم اجرا کنیم.
یک وب سرویس RESTful به ما امکان دسترسی به فرمت های مختلف داده مانند متن ساده، HTML، XML، JSON و غیره را می دهد.
با توجه به این توضیحات، REST در واقع یک راه ساده و انعطاف پذیر برای استفاده از API و البته معروف ترین و پرکاربردترین آن است که از طریق آن می توان یک درخواست ساده (HTTPS) از هر کلاینت و پلتفرمی ارسال کرد و پاسخ آن را از این طریق دریافت کرد. . به همین دلیل امکان استفاده از پنل پیامک sms.ir را نیز داریم خدمات وب شکستن برای کاربران عزیز قرار داده ایم.
برای استفاده از این وب سرویس باید وارد پنل کاربری خود شوید و از منوی برنامه نویسان به تمامی موارد مورد نیاز خود دسترسی خواهید داشت.
کلید وب سرویس:
برای برقراری ارتباط از طریق برنامه نویسی، باید یک توکن ایجاد کنید و برای ایجاد یک توکن، به کلید وب سرویس و رمز امنیتی تولید شده در این قسمت نیاز دارید. سپس با استفاده از رمز امنیتی می توانید روش های وب سرویس Rest را فراخوانی کنید.
یک کد امنیتی مانند تصویر زیر بنویسید این کد می تواند مجموعه ای از حروف، اعداد و برخی حروف باشد. کاراکترهای مسدود شده عبارتند از: "" # $
سپس روی دکمه Generate Key کلیک کنید تا یک کلید وب سرویس برای شما ایجاد شود. شما می توانید توکن خود را با استفاده از این دو بسازید.
قبل از هر سفارش حتما توکن را دریافت کنید. توجه داشته باشید که کد امنیتی پس از 30 دقیقه منقضی می شود و باید دوباره کد امنیتی را دریافت کنید.
خدمات وب راحت :
لیستی از روش ها و مستندات مورد استفاده و همچنین نمونه کد Postman-c#-php در این قسمت ارائه شده است.
همانطور که در تصویر زیر نشان داده شده است، بر روی هر یک از بخش هایی که در سمت راست می خواهید کلیک کنید و Code Samples را انتخاب کنید.
هر چیزی که ممکن است نیاز داشته باشید (فیلم های آموزشی، بسته های مورد نیاز و غیره) در این قسمت وجود دارد.
سرویس پیامک آنلاین
الگوهای ماژول ارسال سریع:
این بخش مربوط به واحد انتقال سریع است. با خرید ماژول Fast Send که در حال حاضر 6500 پیامک در سال هزینه دارد، می توانید به راحتی OTP خود را با بالاترین سرعت از طریق وب سرویس برای همه افراد حتی لیست سیاه ارسال کنید. توجه داشته باشید که 6500 پیامک قیمت خرید این واحد برای یک سال است نه تعداد پیامکی که می توانید از آن ارسال کنید. برای ارسال پیامک از این واحد، باید با استفاده از موجودی بالای صفحه، پیامک را جداگانه خریداری کنید.
شما می توانید این دستگاه را همانطور که در تصویر زیر نشان داده شده است از ویژگی های اساسی مورد نیاز خریداری کنید و ویژگی های پنل را فعال کنید.
توجه داشته باشید که این ماژول فقط از طریق وب سرویس قابل استفاده است و نمی توانید از داخل پنل از این ماژول ارسال کنید.
شما می توانید از این ماژول به دو صورت استفاده کنید:
ارسال کد تایید
از این روش برای ارسال سریع اس ام اس استفاده می شود، در این صورت می توانید برای ثبت سایت خود از این روش استفاده کنید، کافی است فقط از نمونه کدهای موجود در منوی برنامه نویسان، وب سرویس های راحت، قسمت ارسال کد تایید استفاده کنید.
برای استفاده از این بخش کافیست یک کد خاص به شماره تلفن همراه ارسال کنید، هیچ پارامتر دیگری نیاز نیست. پیامک شما به این صورت ارسال می شود:
مثال در پستچی:
{“Code”: “12345”,\xa0\xa0 “MobileNumber”: “0912XXXXXX1”}
کد تایید عضویت شما: 12345
حمل و نقل سریع با قالب :
در صورتی می توانید از این روش استفاده کنید که دریافت پیامک در کمتر از چند ثانیه هنگام ثبت نام، فراموشی رمز عبور، سفارش، تغییر اقلام صورتحساب و غیره برای شما مهم است. در این روش ابتدا برای هر قسمت از فعالیت سایت خود که می خواهید برای آن پیامک ارسال کنید یک قالب انتخاب می کنید سپس با استفاده از شناسه قالب و پارامترهای موجود در قالب، محتوای مورد نظر در کمتر از یک دقیقه برای مشتریان شما ارسال می شود. چند ثانیه برای طراحی قالب مورد نظر خود می توانید به منوی Programmers، Quick Render Templates رفته و مطابق تصویر زیر با پارامترهای رندر قالب مورد نظر را ایجاد کنید:
قالب هایی که ایجاد می کنید توسط کارشناسان sms.ir بررسی می شود و در صورت عدم مغایرت با قوانین ماژول ارسال اکسپرس، قالب ها پس از چند دقیقه تایید می شوند، در صورت تایید نشدن دلیل آن برای شما نوشته می شود و می توانید تعمیر کنید
قالب های ایجاد شده قابل ویرایش نیستند، فقط می توانید آنها را حذف کنید و یک الگوی جدید ایجاد کنید.
دقت داشته باشید که الگو باید مطابق نمونه تولید شود و پارامترهای ارسالی با () نوشته شود. محدودیتی برای تعداد پارامترهایی که مشخص می کنید وجود ندارد، اما متن ارسالی در هر پارامتر دارای محدودیت 50 کاراکتر است.
پس از ساخت و تایید قالب می توانید به منوی برنامه نویسان، وب سرویس های راحت و قسمت ارسال سریع همراه با قالب بروید و در آنجا به نمونه کدها دسترسی خواهید داشت. هر قالبی که ایجاد می کنید دارای شناسه قالب است و باید از این شناسه در کد خود استفاده کنید تا آن را از طریق همان الگو ارسال کنید.
در این روش متغیرهای ایجاد شده در قالب، شماره موبایل و شناسه قالب مشخص می شوند.
مثال در پستچی:
{
"ماتریس پارامتر":(
{ "parameter": "verification code", "parameter value": "123654"}
)
"موبایل":"0912XXXXXX1"،
"شناسه الگو": "26"
}
کد ثبت : 123654
منبع: https://sms.ir/blog/guides/programming/%D9%88%D8%A8-%D8%B3%D8%B1%D9%88%DB%8C%D8%B3-restful/