نحوه استفاده از وب سرویس خرید شارژ و پرداخت قبض آینکس، در این مطلب آموزش داده می شود. در این وب سرویس امکان استفاده از تمام زبان های برنامه نویسی فراهم می باشد
نکات مهم پیش از استفاده:
– در صورتی که برنامه نویس تلفن همراه هستید و قصد دارید از وب سرویس آینکس در اپلیکیشن خود استفاده کنید، پیشنهاد می شود از ارسال مستقیم پارامترها به آدرس وب سرویس آینکس خودداری نمائید. پیشنهاد ما تهیه دامنه و هاست به نام خودتان و ارسال پارامترها به این دامنه است. جهت تهیه هاست یا دامنه می توانید از سیمانت استفاده کنید.
ارسال مستقیم پارامتر ها به آینکس معایبی دارد منجمله:
1- محدودیت در ایجاد بخش های جدید در اپلیکیشن به علت نبود دیتابیس سمت اپلیکیشن
2- عدم امکان ثبت نام کاربر در اپلیکیشن
3- عدم توانایی پیاده سازی قابلیت پرداخت از کیف پول در اپلیکیشن
4- عدم امکان نمایش تراکنش های خریدار در اپلیکیشن
آدرس وب سرویس :
تمامی درخواست ها با متد POST و به صورت json به آدرس زیر ارسال می شود
https://inax.ir/webservice.php
شرح متدها :
از متدهای زیر جهت ارتباط با وب سرویس استفاده می گردد.
| نام متد | توضیح |
| credit | استعلام موجودی حساب |
| addfund | افزایش موجودی حساب |
| get_products | دریافت قیمت و لیست محصولات (کارت شارژ پین – گیفت کارت – بسته اینترنت – آنتی ویروس و …) |
| topup | خرید شارژ مستقیم – شارژ شگفت انگیز – شارژ سیم کارت ترابرد شده |
| pin | خرید کارت شارژ پین |
| check_bill | استعلام مبلغ و نوع قبض |
| pay_bill | پرداخت قبض |
| buy_product | خرید محصول |
- مقادیر ورودی باید از طریق پروتکل POST به سرور آینکس ارسال شود.
- خروجی تمامی متد ها به صورت JSON تولید می گردد.
متد استعلام موجودی نماینده credit :
با استفاده از این متد می توانید موجودی حساب را استعلام نمائید
پارامترهای ورودی متد credit :
| نام پارامتر | مثال | ضروریت | توضیح |
| method | credit | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
مقادیر بازگشتی متد credit :
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| credit | 1200 | موجودی نماینده به تومان |
متد افزایش اعتبار نمایندگی addfund :
با استفاده از این متد می توانید بدون نیاز به ورود به پنل آینکس، موجودی حساب خود را افزایش دهید.
پارامترهای ورودی متد credit :
| نام پارامتر | مثال | ضروریت | توضیح |
| method | addfund | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| amount | 10,000 | اجباری | مبلغ مورد نظر جهت افزایش موجودی به تومان |
مقادیر بازگشتی متد addfund:
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| trans_id | 2557 | شناسه تراکنش ایجاد شده در آینکس.پس از دریافت شناسه تراکنش کاربر به لینک زیر هدایت می شود https://inax.ir/pay.php?tid=2557 |
متد دریافت لیست محصولات get_products :
منظور از محصولات در اینجا کارت شارژ پین، بسته اینترنت، گیفت کارت، آنتی ویروس و … است.
این متد اطلاعات محصولات موجود را به نماینده نشان می دهد تا نماینده بر اساس این اطلاعات درخواست دریافت محصول را صادر نماید. اطلاعاتی از قبیل عنوان محصول، شناسه یکتای محصول و قیمت آن توسط این متد به نماینده ارائه می گردد.
باتوجه به اینکه حجم اطلاعات دریافتی از طریق این متد زیاد است و این اطلاعات به صورت مداوم به روز رسانی نمی شود لذا نیازی به دریافت آنلاین این اطلاعات در هر بار خرید نیست. پیشنهاد می شود این متد توسط کران جابز سیستم روزی یک مرتبه اجرا و اطلاعات دریافتی در دیتابیس یا فایلی در سرور خودتان ذخیره شده و فراخوانی اطلاعات از روی این فایل انجام گیرد.
انجام این کار موجب افزایش سرعت دریافت و بازخوانی اطلاعات خرید خواهد گردید.
پارامترهای ورودی متد get_products:
| نام پارامتر | مثال | ضروریت | توضیح |
| method | get_products | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
مقادیر بازگشتی متد get_products :
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| products | – | لیست کل محصولات موجود به صورت json
هر محصول دارای id ، name , amount می باشد. مبلغ محصولات به تومان ذکر شده است. |
متد خرید شارژ مستقیم topup:
توسط این متد می توانید کارت شارژ مستقیم و شگفت انگیز و وایمکس خریداری نمائید.
متد خرید بسته اینترنت buy_internet :
از این متد می توانید جهت خرید بسته های اینترنت استفاده نمائید
پارامترهای ورودی متد buy_internet:
| نام پارامتر | مثال | ضروریت | توضیح |
| method | buy_internet | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| product_id | IN-MTN-M-158 | اجباری | آیدی محصول (دریافت شده توسط متد get_products) |
| operator | MTN | اجباری | MTN : ایرانسل MCI : همراه اول RTL : رایتل |
| mobile | 09123456789 | اجباری | شماره تلفن همراهی که قصد شارژش را دارید |
| internet_type | hourly | اجباری | نوع بسته اینترنت hourly – بسته اینترنت ساعتی daily – بسته اینترنت روزانه weekly – بسته اینترنت هفتگی monthly – بسته اینترنت ماهیانه yearly – بسته اینترنت سالیانه amazing – بسته اینترنت شگفت انگیز TDLTE – بسته های اینترنت TDLTE |
| sim_type | credit | اجباری | نوع سیم کارت: credit – اعتباری permanent – دایمی |
| order_id | 2350 | اجباری | شماره تراکنش در سایت شما (باید منحصر به فرد باشد) |
مقادیر بازگشتی متد buy_internet :
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| ref_code | 65455 | شماره پیگیری |
پارامترهای ورودی متد topup :
| نام پارامتر | مثال | ضروریت | توضیح |
| method | topup | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| operator | MTN | اجباری | MTN : شارژ ایرانسل MCI : شارژ همراه اول RTL : شارژ رایتل |
| amount | 2000 | اجباری | برای اپراتورهای ایرانسل و رایتل مبلغ شارژ از 500 تومان تا 50,000 تومان پذیرفته می شود . برای اپراتور همراه اول مبالغ 1,000 ، 2,000 ، 5,000 ، 10,000 ، 20,000 تومان قابل قبول است. |
| mobile | 09123456789 | اجباری | شماره تلفن همراهی که قصد شارژش را دارید |
| charge_type | normal | اجباری | نوع شارژ سیم کارت. موارد مورد قبول: normal – شارژ معمولی amazing – شارژ شگفت انگیز mnp – شارژ سیم کارت ترابرد شده permanent – شارژ سیم کارت دایمی (ایرانسل) |
| order_id | 2350 | اجباری | شماره تراکنش در سایت شما (باید منحصر به فرد باشد) |
| company | آینکس | اجباری | نام نمایشی در پیامک ارسالی به خریدار پس از انجام شارژ مستقیم |
متد خرید کارت شارژ pin:
توسط این متد می توانید کارت شارژ فیزیکی خریداری نمائید.
پارامترهای ورودی متد pin :
| نام پارامتر | مثال | ضروریت | توضیح |
| method | pin | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| operator | MTN | اجباری | MTN : شارژ ایرانسل MCI : شارژ همراه اول RTL : شارژ رایتل TAL : شارژ تالیا |
| amount | 2000 | اجباری | برای اپراتورهای ایرانسل و همراه اول مبالغ 1,000 ، 2,000 ، 5,000 ، 10,000 ، 20,000 تومان برای اپراتور رایتل مبالغ 2,000 ، 5,000 ، 10,000 ، 20,000 تومان |
| mobile | 09123456789 | اجباری | شماره تلفن همراهی که قصد شارژش را دارید |
| order_id | 2350 | اجباری | شماره تراکنش در سایت شما (باید منحصر به فرد باشد) |
| count | 1 | اجباری | تعداد خرید کارت شارژ |
مقادیر بازگشتی متد pin :
در صورتی که پارامترهای ورودی معتبر باشد مقدار res_code برابر 1 خواهد بود. در غیر این صورت مقدار res_code برابر با کد خطایی خواهد بود که در جدول کدهای خطا نمایش داده شده است
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| ref_code | 553544544 | رسید تراکنش |
| buy_info | یک آرایه شامل pin و serial کارت شارژ ها | رسید تراکنش |
متد بررسی مبلغ و نوع قبض check_bill :
با استفاده از این متد نوع قبض و مبلغ آن از روی شناسه پرداخت و شناسه قبض استعلام می گردد.
پارامترهای ورودی متد check_bill :
| نام پارامتر | مثال | ضروریت | توضیح |
| method | check_bill | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| bill_id | 12345678910 | اجباری | شناسه قبض |
| pay_id | 326541 | اجباری | شناسه پرداخت |
مقادیر بازگشتی متد check_bill :
در صورتی که شناسه پرداخت و شناسه قبض معتبر باشد مقدار res_code برابر 1 خواهد بود. در غیر این صورت مقدار res_code برابر با کد خطایی خواهد بود که در جدول کدهای خطا نمایش داده شده است
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| bill_type | water | نوع قبض
این فیلد عددی به صورت زیر بیانگر شرکت خدماتی قبض است: |
| amount | 14500 | مبلغ (تومان) |
متد پرداخت قبض pay_bill :
توسط این مند می توانید قبض ها را توسط شناسه پرداخت و شناسه قبض، پرداخت نمائید.
پارامترهای ورودی متد pay_bill :
| نام پارامتر | مثال | ضروریت | توضیح |
| method | pay_bill | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| bill_id | 12345678910 | اجباری | شناسه قبض |
| pay_id | 326541 | اجباری | شناسه پرداخت |
| mobile | 09123456789 | اجباری | شماره موبایل خریدار (جهت پشتیبانی در صورت بروز مشکل) |
| order_id | 1223 | اجباری | شماره تراکنش در سایت شما (باید منحصر به فرد باشد) |
مقادیر بازگشتی متد pay_bill :
در صورتی که مقادیر دریافتی توسط متد فوق معتبر باشد. قبض مورد نظر پرداخت شده و شماره پیگیری پرداخت در پاسخ ارسال می گردد
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| ref_code | 65455 | شماره پیگیری تراکنش |
متد خرید محصول buy_product :
توسط این مند می توانید نسبت به خرید محصولاتی که توسط متد products دریافت نموده اید اقدام نمائید.
توجه نمائید با توجه به امکان تغییر قیمت یا لیست محصولات، همواره از طریق متد products لیست محصولات را دریافت نمائید
پارامترهای ورودی متد buy_product :
| نام پارامتر | مثال | ضروریت | توضیح |
| method | buy_product | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| product_id | CC-MCI-1000 | اجباری | آیدی محصول (دریافت شده توسط متد products) |
| count | 2 | اختیاری | در صورت عدم ارسال این پارامتر مقدار 1 در نظر گرفته می شود |
| mobile | 09123456789 | اجباری | شماره موبایل خریدار (جهت پشتیبانی در صورت بروز مشکل) |
| order_id | 1223 | اجباری | شماره تراکنش در سایت شما (باید منحصر به فرد باشد) |
مقادیر بازگشتی متد buy_product :
در صورتی که مقادیر دریافتی توسط متد فوق معتبر باشد. محصول مورد نظر خریداری شده و مقادیر زیر بازگشت داده می شود
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| buy_info | [{“Pin”:”878758437631248″,”ExtraData”:{“Serial”:”90170526170019607″}}] | اطلاعات محصولات خریداری شده به صورت آرایه json |
| ref_code | 65455 | شماره پیگیری |
متد استعلام اطلاعات تراکنش retrieve_product_info :
توسط این می توانید جزئیات محصولات خریداری شده را دریافت نمائید.
پارامترهای ورودی متد retrieve_product_info :
| نام پارامتر | مثال | ضروریت | توضیح |
| method | retrieve_product_info | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| ref_code | 65455 | اجباری | شماره پیگیری |
مقادیر بازگشتی متد retrieve_product_info :
در صورتی که مقادیر دریافتی توسط متد فوق معتبر باشد. جزئیات محصول خریداری شده به مانند جدول زیر بازگشت داده می شود.
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| trans_id | 2557 | شناسه تراکنش |
| buy_info | [{“Pin”:”878758437631248″,”ExtraData”:{“Serial”:”90170526170019607″}}] | اطلاعات محصولات خریداری شده به صورت آرایه json |
متد ایجاد فاکتور خرید invoice :
با استفاده از این متد می توانید نسبت به ایجاد یک فاکتور پرداخت برای خرید شارژ مستقیم، شارژ پین، پرداخت قبض ، بسته اینترنت و … استفاده نمائید. این متد زمانی کاربرد دارد که شما درگاه پرداخت نداشته باشید و بخواهید از درگاه آینکس جهت دریافت مبلغ تراکنش ها استفاده نمائید.
پارامترهای ورودی متد invoice:
| نام پارامتر | مثال | ضروریت | توضیح |
| method | invoice | اجباری | نام متد |
| username | 123 | اجباری | نام کاربری وب سرویس |
| password | 321 | اجباری | پسورد وب سرویس |
| product | topup | اجباری | نام محصول- موارد مورد قبول : topup , pin, bill, internet |
| mobile | 09123456789 | اجباری | شماره موبایل خریدار |
| operator | MTN | اگر product از نوع topup باشد اجباری | MTN : شارژ ایرانسل MCI : شارژ همراه اول RTL : شارژ رایتل |
| charge_type | normal | اگر product از نوع topup باشد اجباری | نوع شارژ سیم کارت. موارد مورد قبول: normal – شارژ معمولی amazing – شارژ شگفت انگیز mnp – شارژ سیم کارت ترابرد شده permanent – شارژ سیم کارت دایمی (ایرانسل) |
| order_id | 2350 | اجباری | شماره سفارش |
| bill_id | 12345678910 | اگر product از نوع bill باشد اجباری | شناسه قبض |
| pay_id | 326541 | اگر product از نوع bill باشد اجباری | شناسه پرداخت |
| product_id | 35874588 | اگر product از نوع internet باشد اجباری | آیدی بسته اینترنت |
| internet_type | daily | اگر product از نوع internet باشد اجباری | مدت زمان بسته اینترنت. موارد مورد قبول: hourly – بسته اینترنت ساعتی daily – بسته اینترنت روزانه weekly – بسته اینترنت هفتگی monthly – بسته اینترنت ماهیانه yearly – بسته اینترنت سالیانه amazing – بسته اینترنت شگفت انگیز TDLTE – بسته های اینترنت TDLTE |
| sim_type | credit | اگر product از نوع internet باشد اجباری | نوع سیم کارت: credit – اعتباری permanent – دایمی |
| count | 2 | اختیاری | در صورت عدم ارسال این پارامتر مقدار 1 در نظر گرفته می شود |
| amount | 2000 | اگر product از نوع topup یا pin باشد اجباری | برای اپراتورهای ایرانسل و رایتل مبلغ شارژ از 500 تومان تا 50,000 تومان پذیرفته می شود . برای اپراتور همراه اول مبالغ 1,000 ، 2,000 ، 5,000 ، 10,000 ، 20,000 تومان قابل قبول است. |
| company | آینکس | اجباری | نام نمایشی در پیامک ارسالی به خریدار پس از انجام شارژ مستقیم |
| callback | http://example.com/invoice=1050 | اختیاری | لینک بازگشت به سایت خریدار پس از انجام تراکنش |
مقادیر بازگشتی متد invoice :
| نام پارامتر | مثال | توضیح |
| res_code | 1 | در صورت موفق بودن عدد 1 در غیر این صورت مطابق جدول کدهای خطا |
| trans_id | 2557 | شناسه تراکنش ایجاد شده در آینکس.پس از دریافت شناسه تراکنش کاربر به لینک زیر هدایت می شود https://inax.ir/pay.php?tid=2557 |
کدهای خطا res_code
| کد خطا | توضیح |
| 1 | عملیات موفقیت آمیز است |
| 11- | اطلاعات ارسال شده ناقص است |
| 12- | شماره تلفن وارد شده در شارژ مستقیم صحیح نمی باشد یا با نوع اپراتور همخوانی ندارد |
| 13- | شناسه قبض نامعتبر است. |
| 14- | شناسه پرداخت نامعتبر است. |
| 15- | شناسه قبض و شناسه پرداخت همخوانی ندارند. |
| 16- | قبضی با این مشخصات قبلاً در سیستم ثبت شده است. |
| 18- | شماره تلفن وارد شده مربوط به سیم کارت دائمی همراه اول نمی باشد |
| 22- | اطلاعات احراز هویت صحیح نیست. |
| 33- | اعتبار نماینده کمتر از مبلغ درخواستی است. |
| 44- | مبلغ درخواست خارج از محدوده است یا محصول مورد نظر موجود نمی باشد |
| 55- | تراکنشی با شماره ارسال شده وجود ندارد. |
| 66- | اپراتور شارژ مستقیم ایرانسل در دسترس نمی باشد. |
| 67- | اپراتور شارژ مستقیم همراه اول در دسترس نمی باشد |
| 77- | شماره درخواست (order_id) تکراری است. |
| 91- | سیستم موقتاً با مشکل مواجه شده است. |
اسکریپت نمایندگی فروش کارت شارژ:
توسط این اسکریپت می توانید اقدام به فروش کارت شارژ نموده و کسب درآمد کنید. علاوه بر آن نمونه کدی برای نحوه استفاده از وب سرویس فوق می باشد.
نیازی به ساخت دیتابیس نبوده و تمامی تراکنش ها در پنل آینکس ذخیره می گردد.
برای دانلود اسکریپت بر روی لینک زیر کلیک نمائید.