امروزه با گسترش اینترنت و استفاده عموم و شرکت ها از آن ، بسیاری از سیستم های آنلاین را بر آن داشت تا راهی برای ارتباط دو سیستم از راه دور و بواسطه اینترنت بیابند. انجام این امر بدین شکل است که یک نرم افزار در یک سیستم بتواند مقادیری به عنوان ورودی در تابعی که در نرم افزار سیستم دوم وجود دارد فراخوانی کند و مقادیری را بصورت خروجی دریافت کند. در واقع نیاز مبرم به اتصال دو سیستم از راه دور موجب گشت تا وب سرویس بوجود بیاید.
وب سرویس چیست؟
در تعریف وب سرویس میتوان گفت وب سرویس، قطعه کدهایی است که تحت وب قابل دسترسی است و از طریق پروتکلهای استانداردی به انتقال و مبادله دیتا با سایر برنامه های کاربردی که تحت وب دردسترس هستند، میپردازد. اساس کار وب سرویسها بر پایه دریافت ورودی و تولید پیغام خروجی ایجاد شده است؛ بدین معنی که آنها منتظر می مانند که کلاینتها به آنها وصل شده و بنا به درخواست کلاینتها به آنها پاسخ میدهند.WSDL چیست؟
WSDL یک استاندارد مهم در وب سرویس است. هر وب سرویس دارای یک فایل WSDL میباشد. این فایل به توصیف وب سرویس میپردازد و نحوه استفاده از وب سرویس را توضیح میدهد که به برنامهها می گوید که وب سرویس مورد نظر چه ورودیهایی دریافت و چه خروجیهایی را به آن برمیگرداند . WSDL صرفا برای برنامه طراحی شده است و برای کاربران استفاده کننده از وب سرویس طراحی نشده است. بسیاری از نرم افزارهایی که به ساخت وب سرویس می پردازند فایل WSDL وب سرویس را نیز خود به صورت اتوماتیک تولید می کنند. لازم به ذکر است که بصورت معمول در web apiهای مبتنی بر پروتکل soap برای ارائه توضیحات رفتار و ویژگیهای وب سرویس از فایل wsdl استفاده میشود. اما در وب سرویسهاس REST یا RESTfull از که یک خود یک سبکی از معماری است برای ارائه توضیحات ویژگیهای وب سرویس از فایل RSDL استفاده میشود. در سامانه ملی پیامکی با دو شیوه میتوان به وب سرویس پیامکی متصل شد:1- وب سرویس REST
یک مدل معماری برای ارائه سرویس ها و API های عمومی روی بستر اینترنت با استفاده از پروتکل HTTP میباشد .وب سرویس REST روی دسترسی به منابع آدرس دار با یک رابط مشخص تمرکز دارد . یعنی هر منبعی حاوی یک URL معین و واحدی است. در این نوع از طراحی، از عملیات موجود در خود HTTP بهره برداری می شود. در ملی پیامک با استفاده از متد GET و همچنین با استفاده از متد POST میتوان از وب سرویس استفاده کرد. برای مشاهده نمونه کدهای اتصال به وب سرویس سامانه ملی پیامک میتوانید از صفحه مستندات دیدن فرمایید. که در آن کاربر مقادیر ورودی شامل نام کاربری ، رمزعبور، شماره خط فرستنده ، شماره خط گیرنده و متن پیامک را ارسال میکند و در مقابل به صورت یکسری کدهای عددی که در سیستم تعریف شده وضعیت ارسال را در خروجی نمایش میدهد.2- وب سرویس SOAP
SOAP یک پروتکل انتقال است که به برنامه ی در حال اجرا بر روی سیستم های مجزا اجازه انتقال و تبادل پیام را می دهد. البته برخی ازSOAP به اشتباه "وب سرویس" نام می برند. فرمت پیام ها در این نوع وب سرویسXML می باشد و ساختار پیام مخصوص خود را دارد. فرمت XML به شکل زیر می باشد:POST /post/send.asmx HTTP/1.1
Host: 37.228.138.118
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://tempuri.org/SendSimpleSMS2"
string
string
string
string
string
boolean
در قطعه کد فوق نحوه فراخوانی متد SendSimpleSMS2 که برای ارسال پیامک تکی از وب سرویس در ملی پیامک کاربرد دارد ، آمده است.
با وب سرویس ملی پیامک شما میتوانید به راحتی به تمامی امور پیامکی و غیرپیامکی از قبیل ارسال پیامک ، ارسال پیامک زماندار، ارسال پیامک صوتی،ارسال پیامک از طریق وب سرویس خدماتی، دریافت وضعیت تحویل پیامک (دلیوری) ، دریافت و یا تغییر موجودی حساب، حذف پیامک، مشاهده پیام های ارسالی و دریافتی( صندوق دریافت )، دسترسی به امور تیکتی سامانه، اضافه کردن کاربر (زیر کاربر و یا کاربر در پنل های نمایندگی) و عملیات های کاربری، ایجاد شاخه و کار با عملیات های مربوط به آن، ...، روی SOAP دسترسی داشته باشید .
آدرس وب سرویس SOAP
برای استفاده از SOAP نیاز هست که برنامه کاربر از طریق آدرس هایی که داخل مستندات درج شده است به وب سرویس ملی پیامک متصل شود. این آدرس ها شامل مقادیر زیر می باشند:- https://api.payamak-panel.com/post/send.asmx
- https://api.payamak-panel.com/post/receive.asmx
- https://api.payamak-panel.com/post/Users.asmx
- https://api.payamak-panel.com/post/contacts.asmx
- https://api.payamak-panel.com/post/actions.asmx
- https://api.payamak-panel.com/post/Schedule.asmx
- https://api.payamak-panel.com/post/Voice.asmx
پارامترهای سرویس SOAP
در متد فوق پارامتر های ورودی به این شکل تعریف می گردد:- پارامترهای username و password: اطلاعات ورود به پنل ملی پیامک.
- پارامتر to: شماره گیرنده.
- پارامتر from: شماره فرستنده.
- پارامتر text: متن پیامک ارسالی.
- پارامتر isflash: تعیین میکند که آیا پیامک به صورت فلش ارسال گردد(true) یا خیر(false) که معمولا میبایست false باشد.
خروجی سرویس SOAP
اما در مقابل وب سرویس میتواند یکی از مقادیر زیر را به عنوان خروجی برگرداند:- رشته عددی Recid : ارسال با موفقیت انجام شده است.
- 0 : نام کاربری یا رمز عبور اشتباه می باشد.
- 1 : درخواست با موفقیت انجام شد.
- 2 : اعتبار کافی نمی باشد.
- 3 : محدودیت در ارسال روزانه
- 4 : محدودیت در حجم ارسال
- 5 : شماره فرستنده معتبر نمی باشد.
- 6 : سامانه در حال بروزرسانی می باشد.
- 7 : متن حاوی کلمه فیلتر شده می باشد.
- 9 : ارسال از خطوط عمومی از طریق وب سرویس امکان پذیر نمی باشد.
- 10 : کاربر مورد نظر فعال نمی باشد.
- 11 : ارسال نشده
- 12 : مدارک کاربر کامل نمی باشد.
کاربرد و نحوه عملکرد | متد |
برای ارسال گروهی استفاده می شود ، شماره های گیرنده در قالب آرایه به پارامتر to داده می شوند. (محدودیت ارسال 100 پیامک در هر بار ارسال می باشد.) | SendSimpleSMS |
برای ارسال تکی استفاده می شود. | SendSimpleSMS2 |
برای ارسال روی یک پورت خاص استفاده میشود. مثلا به دلیل وجود فایروال نیاز هست که ارسال در پورت خاصی به بخاطر مسائل امنیتی صورت گیرد. | SendSms |
با استفاده از RecId وضعیت ارسال پیام را مشخص می کند. | GetDeliveries |
برای دریافت پیامک استفاده می شود. Location : مقدار 1 برای پیامک های دریافتی و 2 پیامک های ارسالی و -1 کلیه پیامک های دریافتی و ارسالی Index : ردیفی که از آن شروع به خواندن می کند . Count : تعداد رکورد درخواستی (حداکثر 100 عدد در هر بار) | GetMessages |
برای ارسال پیامک با متن پیشفرض از خط خدماتی اشتراکی استفاده میشود. | SendByBaseNumber |
به دنبال رشد کسب و کارتان هستید؟
ملیپیامک به شما امکان جذب، نگهداری و تعامل با مشتری را می دهد.
ثبت نام و ارسال پیامک
ثبت نام در کمتر از 1 دقیقه
بحث درباره این مقاله را شما آغاز کنید!
ارسال دیدگاه