لوگوی sms.ir
ایجاد حساب ورود به پنل

وب سرویس RESTful

وب سرویس RESTful یا REST ( مخفف  Representational State Transfer ) یک سبک معماری و مجموعه ای از دستورالعمل هایی است که برای انتقال داده استفاده می شوند. در معماری REST به جای استفاده از روش های پیچیده مانند SOAP از HTTP ساده برای اتصال دو سیستم (client-server) استفاده می شود.

به برنامه های برپایه این معماری RESTful Application  می گویند . RESTful API ها در واقع 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 را برای کاربران عزیز فراهم کرده ایم.

برای استفاده از این وب سرویس می بایست وارد پنل کاربری خود شده و از منوی برنامه نویسان ، به همه مواردی که نیاز دارید دسترسی خواهید داشت.

 

کلید وب سرویس :

برای ارتباط از طریق برنامه نویسی نیاز به ایجاد توکن است و برای ایجاد توکن نیاز به کلید وب سرویس و کد امنیتی دارید که در این بخش ایجاد می شود. سپس با استفاده از Token امنیتی می توانید متدهای وب سرویس Rest را فراخوانی کنید.

همانند تصویر زیر یک کد امنیتی تایپ نمایید، این کد می تواند ترکیبی از حروف و اعداد و برخی کاراکترها باشد. کارکترهای ممنوعه عبارتند از : ”  ‘  # $

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

دقت داشته باشید که قبل از هر درخواست خود توکن را دریافت نمایید. توجه کنید که  توکن امنیتی پس از ۳۰ دقیقه منقضی می گردد و بایستی مجددا توکن امنیتی را دریافت نمایید.

وب سرویس های RESTful :

لیست متدها و داکیومنت های مورد استفاده و هم چنین نمونه کدهای postman – c# – php دراین قسمت قرار دارد.

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

تمامی مواردی که ممکن است بدان ها نیاز داشته باشید ( ویدیوهای آموزشی، بسته های مورد نیاز و …) در این قسمت قرار دارند.

 

قالب های ماژول ارسال سریع :

این بخش مربوط به ماژول ارسال سریع می باشد. با خریداری ماژول ارسال سریع که در حال حاضر هزینه آن سالانه ۶۵۰۰ پیامک می باشد، شما می توانید از طریق وب سرویس ، ارسال های OTP خود را به راحتی با بالاترین سرعت برای همه اشخاص حتی بلک لیست ها انجام دهید. دقت داشته باشید ۶۵۰۰ پیامک هزینه خریداری این ماژول به مدت یکسال می باشد و تعداد پیامک هایی که می توانید از آن ارسال کنید نیست . برای ارسال پیامک از این ماژول باید جداگانه از طریق اعتبار بالای صفحه پیامک خریداری نمایید.

شما می توانید این ماژول را همانند تصویر زیر از امکانات اولیه مورد نیاز، فعالسازی امکانات پنل خریداری نمایید.

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

شما به ۲ طریق می توانید از این ماژول استفاده نمایید :

ارسال کد verification

این متد برای ارسال سریع پیامک استفاده می شود که می توانید برای ثبت نام سایت خود از این متد استفاده کنید .در این حالت کافی است تنها از نمونه کدها در منوی برنامه نویسان، وب سرویس های restful، بخش ارسال کد verification استفاده نمایید.

برای استفاده از این بخش شما فقط یک کد مشخص را برای یک شماره موبایل ارسال می کنید و نیازی به پارامتر و مورد دیگری نمی باشد. پیامک شما با این متد به صورت زیر ارسال می گردد :

نمونه در postman  :

{“Code”: “۱۲۳۴۵”,   “MobileNumber”: “۰۹۱۲XXXXXX1”}

کد تایید عضویت شما : ۱۲۳۴۵

 

ارسال سریع به همراه قالب :

اگر در قسمت ثبت نام، فراموشی رمز عبور، سفارش، تغییر اقلام فاکتور و … ،  دریافت پیامک در کمتر از چند ثانیه برایتان اهمیت دارد می توانید از این متد استفاده کنید. در این متد می توانید ابتدا قالبی را برای هر قسمت از فعالیت سایتتان که می خواهید پیامکی ارسال شود مشخص کنید، سپس با شناسه قالب و پارامترهای موجود در قالب،  محتوای مورد نظر در کمتر از چند ثانیه برای مشتریانتان ارسال می شود. برای طراحی قالب مورد نظرتان می توانید همانند تصویر زیر به منوی برنامه نویسان، قالب های ارسال سریع رفته و همانند نمونه قالب دلخواه خود را به همراه پارامترهای ارسالی ایجاد کنید:

قالب هایی که ایجاد می کنید توسط کارشناسان sms.ir بررسی شده و در صورت عدم مغایرت با قوانین ماژول ارسال سریع، قالب ها پس از چند دقیقه تایید خواهند شد، در صورت عدم تایید علت آن نیز برای شما نوشته خواهد شد و می توانید مورد را برطرف کنید.

قالب هایی که ایجاد می شوند قابل ویرایش نیستند، تنها می توانید آنها را حذف کرده و یک قالب جدید ایجاد کنید.

دقت داشته باشید قالب باید حتما مطابق با نمونه ایجاد شود و پارامترهای ارسالی در [] نوشته شوند.تعداد پارامترهای مشخص شده توسط شما محدودیتی ندارد اما متن ارسالی در هر پارامتر محدودیت ۵۰ کاراکتری دارد.

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

در این متد، متغیرهای ایجاد شده در قالب، شماره موبایل و شناسه قالب مشخص می شوند.

 

نمونه در postman:

{

“ParameterArray”:[

{ “Parameter”: “VerificationCode”,”ParameterValue”: “۱۲۳۶۵۴”}

],

“Mobile”:”۰۹۱۲XXXXXX1″,

“TemplateId”:”۲۶″

}

کد ثبت نام : ۱۲۳۶۵۴

 

۰ ۰ vote
امتیاز به مقاله

مقالات مرتبط

نظرات کاربران

Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
مشاوره رایگان 0212853
0
Would love your thoughts, please comment.x
()
x