Admin > Server > Web Service
به منظور ساده کردن پردازش های تجاری و استفاده از زیرساخت های سایر تولیدکنندگان نیاز است تبادلاتی بین نرم افزارهای مختلف شرکت ها و سازمان ها انجام شود. این تبادلات از طریق وب سرویس انجام می گیرد. فلسفه ی پدید آمدن وب سرویس این است که همه بتوانند با یک زبان واحد با هم ارتباط داشته باشند. یعنی یک وب سایت با زبان PHP با یک وب سایت Asp.net بتواند تبادل داشته باشد. لذا به هر زبانی که برنامه نویسی می کنید، می توانید از وب سرویس استفاده کنید.
در این راهنما به راه اندازی به WebService در دلتاسیب می پردازیم .
  1. تنظیمات دلتاسیب
  2. راه اندازی وب سرویس
برای فعال کردن وب سرویس در دلتاسیب مسیر زیر را دنبال کنید :
Admin > Server > WebService
ممکن است برای اجرای WebService با خطای زیر رو به رو شوید
در این صورت دستور زیر را در محیط لینوکس اجرا کنید.
در ادامه پیغام ظاهر شده را با وارد کردن حرف y تایید نمایید و منتظر شوید تا بسته ی مورد نیاز دانلود و نصب شود.
پس از پایان نصب دستور زیر را وارد کنید.
با باز کردن WebService پنجره ی زیر را مشاهده خواهید کرد.
IsEnable :

فعال و یا غیر فعال کردن وب سرویس

Port :

شماره پورتی که وب سرویس بر روی آن فعال می شود. حتماً از یک پورت منحصر به فرد روی IP دلتاسیب استفاده کنید.

PermitIP :

کلیه ی IP هایی را که می خواهند به WebService دسترسی داشته باشند. برای دسترسی به تمام IP ها 0.0.0.0/0 را وارد کنید.

برای چک کردن اینکه وب سرویس به درستی راه اندازی شده است، آدرس http://AccountingIP:8080/ws/DSUsers.phpرادر مرورگر وارد کنید.
در این صفحه لیست کلیه ی توابعی را که تا این لحظه از طریق وب سرویس دلتاسیب در دسترس هستند مشاهده می کنید. همچنین کلیه ی پارامترهای ورودی، نوع متغیر ها و پارامترهای خروجی را نیز می توانید در این قسمت مشاهده کنید.
تعریف یوزر برای استفاده ازوب سرویس
در این مرحله باید برای انجام عملیات مختلف یوزرهایی با دسترسی های لازم ایجاد کنیم. برای دسترسی به این بخش به مسیر Admin>WebService بروید.
ISEnable :

برای فعال کردن و یا غیر فعال کردن کاربر

WebService_Username :

تعریف نام کاربری

WebService_UserPass :

تعریف رمز عبور

PermitIP :

IPسرورها و نرم افزارهایی که از طریق این کاربر قصد ارتباط با دلتاسیب را دارند.

Permissions :

برای تعیین مجوزهای کاربر

معرفی توابع وب سرویس
توابع زیر از طریق API در دسترس می باشند.
  1. تعریف یوزر
  2. تغییر وضعیت یوزر
  3. فعال کردن سرویس برای یوزر
  4. ثبت پرداختی یوزر
  5. فعال کردن سرویس رزرو یوزر
  6. حذف کردن یوزر
  7. ارسال SMS برای یوزر
تابع UserCreate:
کاربرد :

برای ایجاد یوزر

توضیح کاراکترهای جدول :
  1. مقادیری که بین کاراکترهای "<>" قرار می گیرند اجباری هستند.
  2. مقادیری که بین کاراکترهای "[ ]" قرار می گیرند اختیاری هستند.
  3. از مقادیری که در دو طرف کاراکتر "|" قرار می گیرند یکی را می توان انتخاب کرد.
درفیلدهایی که هم Name و هم ID ذکر شده است،لازم است یکی از این دو پارامتر مقدار بگیرند. در صورتی که برای هر دو پارامتر مقدار ست شود اولویت با Name خواهد بود. به این معنی که اگر مقدار ID پارامتر با مقدار Nameآن یکسان نباشد، مقداری که برایName در نظر گرفته شده برای کاربر ست خواهد شد.
نام پارامتر نوع شرح
WS_Username String < WS_Username>
نام کاربری که در مرحله ی قبل در پنل دلتاسیب ایجاد شده است و دسترسی ایجاد کاربر جدید به آن اختصاص داده شده است.
WS_Password String < WS_Password>
رمز عبور کاربر ایجاد شده در پنل دلتاسیب
Username String < Username >
نام کاربری که قرار است در دلتاسیب ایجاد شود.
Password String < Password >
رمز عبوری که برای کاربر ست می شود.
Visp_Id
VispName 		Int
String 		< VispName|Visp_Id >
شماره ID و یا نامVISP کاربر
Center_Id
CenterName 		Int
String 		< CenterName|Center_Id
شماره ID و یا نام Center کاربر
Supporter_Id
SupporterName 		Int
String 		< SupporterName|Supporter_Id >
شماره ID و یا نام Supporter کاربر
Reseller_Id
ResellerName 		Int
String 		< ResellerName|Reseller_Id >
شماره ID و یا نام Reseller کاربر
Status_Id
StatusName 		Int
String 		< StatusName|Status_Id >
شماره ID و یا نام وضعیت کاربر
AdslPhone Int [AdslPhone]
شماره تلفن کاربر
NOE Int [NOE]
مختصات وایرلس
IPRouteLog Int [IPRouterLog]
Email String [Email]
آدرس ایمیل کاربر
Comment String [Comment]
توضیحات مورد نیاز
Organization String [Organization]
نام سازمان
CompanyRegistryCode Int [CompanyRegistryCode]
شماره ثبت شرکت
CompanyEconomyCode Int [CompanyEconomyCode]
شماره اقتصادی شرکت
CompanyNationalCode Int [CompanyNationalCode]
شناسه ی ملی شرکت
Name String [Name]
نامی که برای کاربر در نظر گرفته شده است.
Family String [Family]
نام خانوادگی کاربر
FatherName String [FatherName]
نام پدر کاربر
Nationality Int [Nationality]
ملیت کاربر
Mobile Int [Mobile]
شماره همراه کاربر
NationalCode Int [NationalCode]
کد ملی کاربر
BirthDate String [BirthDate]
تاریخ تولد کاربر
Phone Int [Phone]
شماره تلفن ثابت کاربر
Address String [Address]
آدرس کاربر
ExpirationDate Int [ExpirationDate]
تاریخ انقضای یوزر
Service_Id
ServiceName 		Int
String 		[ServiceName|Service_Id]
شماره IDسرویس و یا نام سرویسی که قرار است برای کاربر فعال شود.
تابع UserChangeStatus:
کاربرد :

تغییر وضعیت کاربر

نام پارامتر نوع شرح
WS_Username String < WS_Username >
نام کاربری که در مرحله ی قبل در پنل دلتاسیب ایجاد شده است و دسترسی ایجاد کاربر جدید به آن اختصاص داده شده است.
WS_Password String < WS_Password >
رمز عبور کاربر ایجاد شده در پنل دلتاسیب
User_id
Username 		Int
String 		< UserName | User_Id >
شماره ی ID و یا نام کاربر
Status_Id
StatusName 		Int
String 		< StatusName|Status_Id >
شماره ID و یا نام وضعیت کاربر
Comment String [Comment]
توضیحات مورد نیاز
تایع UserAddService :
کاربرد :

اضافه کردن سرویس برای کاربر

نام پارامتر نوع شرح
WS_Username String < WS_Username >
نام کاربری که در مرحله ی قبل در پنل دلتاسیب ایجاد شده است و دسترسی ایجاد کاربر جدید به آن اختصاص داده شده است.
WS_Password String < WS_Password >
رمز عبور کاربر ایجاد شده در پنل دلتاسیب
User_id
Username 		Int
String 		< UserName | User_Id >
شماره ی ID و یا نام کاربر
Service_Id
ServiceName 		Int
String 		< ServiceName|Service_Id >
شماره IDسرویس و یا نام سرویسی که قرار است برای کاربر فعال شود.
StartDate String [StartDate]
زمان شروع سرویس. در صورتی که سرویس اضافه شده برای کاربر از نوع IP باشد
EndDate String [EndDate]
زمان پایان سرویس. در صورتی که سرویس اضافه شده برای کاربر از نوع IP باشد.
تابع UserAddPayment
کاربرد :

ثبت تراکنش های مالی کاربر.

نام پارامتر نوع شرح
WS_Username String < WS_Username>
نام کاربری که در مرحله ی قبل در پنل دلتاسیب ایجاد شده است و دسترسی ایجاد کاربر جدید به آن اختصاص داده شده است.
WS_Password String < WS_Password>
رمز عبور کاربر ایجاد شده در پنل دلتاسیب
User_id
Username 		Int
String 		< UserName | User_Id >
شماره ی ID و یا نام کاربر
Reseller_Id
ResellerName 		Int
String 		< ResellerName|Reseller_Id >
شماره ID و یا نام Reseller کاربر
Price decimal < Price >
مبلغ تراکنش را تعیین می کند. مبالغ مثبت ثبت به معنای دریافت وجه از کاربر و یا به عبارتی افزایش اعتبار کاربر می باشد. در صورتی که تراکنشی برای کاربر ثبت شود که منجر به کاهش اعتبار وی گردد این مقدار منفی خواهد بود.
PaymentType String < PaymentType >
نوع تراکنش ثبت شده را نمایش می دهد. مقادیری که قابل ثبت شدن هستند :
  1. Cash
  2. Cheque
  3. Pos
  4. Deposit
  5. Tax
  6. Off
  7. Other
Direction String < Direction >
برای ثبت نوع پرداختی کاربر
  1. Get Money : به معنی دریافت پول از می باشد و باعث افزایش اعتبار کاربر می گردد.
  2. Refund Money : برای برگردان پول به حساب کاربر.
VoucherNo String [VoucherNo]
به معنای شماره ی سند پرداختی می باشد و صرفا جنبه ی گزارشی دارد.
VoucherDate String [VoucherDate]
تاریخ سند می باشد که این فیلد نیز فقط برای گزارش گیری می باشد.
BankBranchName String [BankBranchName]
نام شعبه ی بانک صادر کننده ی سند جهت گزارش گیری می باشد.
BankBranchNo String [BankBranchNo]
شماره ی شعبه ی بانک صادر کننده ی سند جهت گزارش گیری می باشد.
Comment String [Comment]
توضیحات مورد نیاز
تابع UserActivateNextService
کاربرد :

فعال کردن سرویس رزرو.

نام پارامتر نوع شرح
WS_Username String < WS_Username >
نام کاربری که در مرحله ی قبل در پنل دلتاسیب ایجاد شده است و دسترسی ایجاد کاربر جدید به آن اختصاص داده شده است.
WS_Password String < WS_Password >
رمز عبور کاربر ایجاد شده در پنل دلتاسیب
User_id
Username 		Int
String 		< UserName | User_Id >
شماره ی ID و یا نام کاربر
تابع UserDelete
کاربرد :

حذف یوزر

نام پارامتر نوع شرح
WS_Username String < WS_Username >
نام کاربری که در مرحله ی قبل در پنل دلتاسیب ایجاد شده است و دسترسی ایجاد کاربر جدید به آن اختصاص داده شده است.
WS_Password String < WS_Password >
رمز عبور کاربر ایجاد شده در پنل دلتاسیب
User_id
Username 		Int
String 		< UserName | User_Id >
شماره ی ID و یا نام کاربر
تابع UserSendSMS
کاربرد :

ارسال پیامک

نام پارامتر نوع شرح
WS_Username String < WS_Username >
نام کاربری که در مرحله ی قبل در پنل دلتاسیب ایجاد شده است و دسترسی ایجاد کاربر جدید به آن اختصاص داده شده است.
WS_Password String < WS_Password >
رمز عبور کاربر ایجاد شده در پنل دلتاسیب
User_id
Username 		Int
String 		< UserName | User_Id >
شماره ی ID و یا نام کاربر
Message String < Message >
متن ارسالی
خروجی توابع
همه ی توابعدارای یک آرایه ی دو مقداری هستند:
ReturnStr :

عنوان خطای بازگشتی

ReturnCode :

کد خطای بازگشتی

مقدار 1 برای متغییر ReturnCode به معنی انجام درست عملیات مورد نظر می باشد.
نمونه کد ساخت یوزر
<?php
date_default_timezone_set("Asia/Tehran");
$user = $_POST['user'];
$pass = $_POST['pass'];
require_once dirname(__FILE__)."/nusoap/nusoap.php";
$client = new nusoap_client("http://ACCOUNTINGIP:8080/ws/DSUsers.php?wsdl", true);
$Param=array(
"WS_Username"=>"r",//webservice username
"WS_Password"=>"8",//webservice password
"Username"=>"$user",
"Password"=>"$pass",
"Visp_Id"=>"1",
"Center_Id"=>"1",
"Supporter_Id"=>"1",
"ResellerName"=>"admin",
"Status_Id"=>"1",
"Service_Id"=>"1"
);
$result = $client->call("UserCreate", $Param);
echo $result["ReturnStr"];