مقدمه
برای شارژ تلفن همراه خود میتوانید از این سرویس شارژ استفاده کنید.
فعالسازی سرویس
ارسال درخواست در سایت پادیوم www.podium.ir:
ابتدا وارد سایت پادیوم شده، سپس در بازارچهی API، سرویسهای مورد نظر خود را انتخاب و درخواست استفاده از آن مجموعه سرویس را ارسال کنید.
درخواست شما توسط کارشناسان پادیوم، بررسی شده و بعد از تایید آن میتوانید از طربق پنل کسب و کار خود اقدام به دریافت کلید اتصال مربوط به آن سرویس نمایید.
منو: پنل کسب و کار – منوی میزکار سرویس گیرنده – درخواستهای ارسالی – در بخش مربوط به سرویس مورد نظر با کلیک بر روی "جزئیات درخواست"
درلیست باز شده با کلیک بر روی تصویر کلید سمت چپ هر سطر جدول میتوانید ApiKey مربوط به آن سرویس را دریافت و ذخیره کنید.
لینک پنل کسب و کار https://panel.pod.ir/Businesses/Requestwebservices
نکته : این کلید در تمام درخواستهای ارسالی از آن سرویس ، ثابت است تا زمانی که کلید جدیدی برای آن سرویس دریافت نشود و به محض دریافت مقدار جدید برای سرویس مورد نظر, کلید قبلی منقضی خواهد شد.
-این کلید در فیلد scApiKey در بخش body درخواست HTTP ، استفاده می شود.
دریافت کلیدهای سرویس یک (دسته/مجموعه) سرویس در قالب یک فایل:
بعداز فشردن دکمه ی تایید سرویس در پنجره باز شده بالا ، برای تمامی سرویسهای موجود در پنل میتوانید از گزینه "دریافت فایل خروجی"، لیست کاملی از سرویسها و کلیدهای scApiKey متناظر با هر یک را دریافت کنید.
سرویس دریافت توکن
برای استفاده از وب سرویس هایی که در ادامه آورده شده، ابتدا باید وب سرویس دریافت توکن را فراخوانی کرد
شناسهی سرویس:
o اصلی: 47512
o سندباکس: ندارد
در تمامی سرویس ها پارامترهای زیر مورد نیاز می باشد.
پارامتر | نوع | توضیحات |
*scProductId | string | شناسه ی سرویس |
*scApiKey | string | توکن |
* پارامتر اجباری
پارامترهای ورودی: ندارد
فیلدهای خروجی:
بدنهی اصلی پاسخ دریافتی در صورت فراخوانی موفق دارای ساختار زیر است:
نام پارامتر | نوع | توضیحات |
hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر |
messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
referenceNumber | string | شناسه ی درخواست در پلتفرم پاد |
errorCode | int | کد ارور پلتفرمی |
Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Result | object | نتیجه ی فراخوانی سرویس(طبق جدول result) |
جدول :result
فیلد | نوع | توضیحات |
token_type | string | نوع توکن |
access_token | string | توکن |
expires_in_sec | string | زمان ابطال توکن |
نمونه پاسخ موفق:
سرویس خرید شارژ
شناسهی سرویس:
o اصلی: 47513
o سندباکس: ندارد
پارامترهای ورودی:
پارامتر | نوع | توضیحات |
*mobileNumber | string | شماره موبایل |
*productCode | string | کد کالا (مطابق جدول productCode ) |
*amount | string | مبلغ شارژ |
*Authorization | String | توکن گرفته شده از سرویس با شماره 47512 مثال: Bearer ejvhfgcbncj |
جدول productCode:
مقدار | توضیحات |
91 | شارژبا مبلغ دلخواه همراه اول |
93 | شارژ عادی ایرانسل |
97 | شارژ شگفت انگیز ایرانسل |
95 | شارژ همراه اول |
94 | شارژ عادی رایتل |
96 | شارژ شگفت انگیز رایتل |
فیلدهای خروجی:
بدنهی اصلی پاسخ دریافتی در صورت فراخوانی موفق دارای ساختار زیر است:
نام پارامتر | نوع | توضیحات |
hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر |
messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
referenceNumber | string | شناسه ی درخواست در پلتفرم پاد |
errorCode | int | کد ارور پلتفرمی |
Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Result | object | نتیجه ی فراخوانی سرویس(طبق جدول result) |
جدول :result
فیلد | نوع | توضیحات |
invoiceId | string | شماره فاکتوری که در درخواست شارژ ارسال شده بود |
responseCode | string | کد پاسخ درخواست |
responseMessage | string | متن پاسخ درخواست |
transactionId | string | شماره تراکنش اپراتور |
otherParams | string | اطلاعات جانبی (در صورتیکه نیاز به ارسال اطلاعات دیگری از سمت سرور به کلاینت باشد) از این فیلد استفاده می شود که در حال حاضر null می باشد |
dateTime | string | تاریخ تراکنش |
نمونه پاسخ موفق:
سرویس لیست بسته های اینترنتی
شناسهی سرویس:
اصلی: 47514
سندباکس: ندارد
پارامترهای ورودی:
پارامتر | نوع | توضیحات | |
*Page | string | شماره صفحه را مشخص می سازد – مقدار پیش فرض یک می باشد | |
*size | string |
| |
*Authorization | String | توکن گرفته شده از سرویس با شماره 47512 مثال: Bearer ejvhfgcbncj |
فیلدهای خروجی:
بدنه ی اصلی پاسخ دریافتی در صورت فراخوانی موفق دارای ساختار زیر است:
نام پارامتر | نوع | توضیحات |
hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر |
messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
referenceNumber | string | شناسه ی درخواست در پلتفرم پاد |
errorCode | int | کد ارور پلتفرمی |
Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Result | object | نتیجه ی فراخوانی سرویس (طبق جدول result) |
جدول :result
فیلد | نوع | توضیحات |
id | Number | شناسه بسته |
operatorCode | String | کد اپراتور(مطابق جدول operatorCode) |
operatorName | String | نام اپراتور |
productCode | String | کد بسته |
packageTimeCode | Number | کد دوره بسته(مطابق جدول packageTimeCode) |
packageTime | String | عنوان دوره بسته |
duration | String | مدت زمان اعتبار به روز |
traffic | String | ترافیک بسته به مگابایت |
nightTraffic | String | ترافیک شبانه بسته به مگابایت |
callNetwork | String | مکالمه درون شبکه برای اپراتور |
price | Number | قیمت بسته به ریال |
priceWithTax | Number | قیمت با ارزش افزوده به ریال |
simeType | Number | کد نوع سیم کارت(مطابق جدول simeType) |
simeTypeDesc | String | عنوان نوع سیم کارت |
description | String | توضیحات |
responseDate | String | زمان پاسخ |
sellRate | Number | رتبه فروش |
otherParams | String | پارامترهای احتمالی که ممکن است اضافه شود |
giftTraffic | String | ترافیک هدیه به مگابایت |
✔ با ارسال productCode در سرویس خرید شارژ (شماره سرویس 47513) امکان فعالسازی بسته اینترنتی برای مشتری امکان پذیر می باشد.
جدول operatorCode:
عنوان | مقدار |
ایرانسل | 1 |
همراه اول | 2 |
رایتل | 3 |
معین | 5 |
شاتل | 6 |
تالیا | 7 |
فناپ موبایل | 8 |
آپتل | 13 |
جیرینگ | 1 |
جدول packageTimeCode:
عنوان | مقدار |
روزانه | 1 |
شبانه | 2 |
ترکیبی | 3 |
مناسبتی | 4 |
جدول simeType:
عنوان | مقدار |
دائمی | 1 |
اعتباری | 2 |
دائمی- اعتباری | 3 |
دیتا – دائمی | 4 |
دیتا – اعتباری | 5 |
نمونه پاسخ موفق:
سرویس جستجوی بسته اینترنت
شناسهی سرویس:
اصلی: 2739661
سندباکس: ندارد
پارامترهای ورودی:
پارامتر | نوع | توضیحات | |
*operatorName | string | نام اپراتور(مطابق جدول operatorName) | |
*duration | string | بسته های ساعتی ، روزانه ، هفتگی ، ماهانه و ... مربوط به هریک از اپراتور ها را استخراج کنید (مطابق جدول duration) | |
*simCardType | string |
| |
*Authorization | String | توکن گرفته شده از سرویس با شماره 47512 مثال: Bearer ejvhfgcbncj |
جدول operatorName:
مقدار | توضیحات |
MTN | ایرانسل |
MCI | همراه اول |
RIGHTEL | رایتل |
MCI-JIRING | همراه اول – کیف پول جیرینگ |
MOEIN | معین |
SHATEL | شاتل |
TALIA | تالیا |
FANAP-MOBILE | فناپ موبایل |
APTEL | آپتل |
جدول duration:
مقدار | توضیحات |
HOURLY | بسته های ساعتی |
1-DAY | بسته های یک روزه |
3-DAY | بسته های سه روزه |
7-DAY | بسته های هفتگی |
15-DAY | بسته های پانزده روزه |
1-MONTH | بسته های یک ماهه |
2-MONTH | بسته های دو ماهه |
3-MONTH | بسته های سه ماهه |
4-MONTH | بسته های چهار ماهه |
6-MONTH | بسته های شش ماهه |
1-YEAR | بسته های یک ساله |
جدول simCardType:
مقدار | نوع سیمکارت |
PERMANENT | دائمی |
PREPAID | اعتباری |
PERMANENT_PREPAID | دائمی-اعتباری |
DATA_PERMANENT | دیتا-دائمی |
DATA_PREPAID | دیتا-اعتباری |
فیلدهای خروجی:
بدنهی اصلی پاسخ دریافتی در صورت فراخوانی موفق دارای ساختار زیر است:
نام پارامتر | نوع | توضیحات |
hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر |
messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
referenceNumber | string | شناسه ی درخواست در پلتفرم پاد |
errorCode | int | کد ارور پلتفرمی |
Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Result | object | نتیجه ی فراخوانی سرویس (طبق جدول result) |
جدول :result
فیلد | نوع | توضیحات |
id | Number | شناسه بسته |
operatorCode | String | کد اپراتور |
operatorName | String | نام اپراتور |
productCode | String | کد بسته |
packageTimeCode | Number | کد دوره بسته |
packageTime | String | عنوان دوره بسته |
duration | String | مدت زمان اعتبار به روز |
traffic | String | ترافیک بسته به مگابایت |
nightTraffic | String | ترافیک شبانه بسته به مگابایت |
callNetwork | String | مکالمه درون شبکه برای اپراتور |
price | Number | قیمت بسته به ریال |
priceWithTax | Number | قیمت با ارزش افزوده به ریال |
simeType | Number | کد نوع سیم کارت |
simeTypeDesc | String | عنوان نوع سیم کارت |
description | String | توضیحات |
responseDate | String | زمان پاسخ |
sellRate | Number | رتبه فروش |
otherParams | String | پارامترهای احتمالی که ممکن است اضافه شود |
giftTraffic | String | ترافیک هدیه به مگابایت |
نمونه پاسخ موفق:
سرویس استعلام خرید شارژ
شناسه ی سرویس:
اصلی: 46176449
پارامترهای ورودی:
پارامتر | نوع | توضیحات |
invoiceId | string | شماره فاکتور |
operatorId | string | کد اپراتور(productCode ) |
transactionDate | string | تاریخ تراکنش |
*Authorization | String | توکن گرفته شده از سرویس با شماره 47512 مثال: Bearer ejvhfgcbncj |
فیلدهای خروجی:
بدنهی اصلی پاسخ دریافتی در صورت فراخوانی موفق دارای ساختار زیر است:
نام پارامتر | نوع | توضیحات |
hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر |
messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
referenceNumber | string | شناسه ی درخواست در پلتفرم پاد |
errorCode | int | کد ارور پلتفرمی |
Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد |
Result | object | نتیجه ی فراخوانی سرویس (طبق جدول result) |
جدول :result
فیلد | نوع | توضیحات |
resultCode | String | کد پاسخ |
resultMsg | String | متن پاسخ |
invoiceId | String | شماره فاکتور |
operatorResponseCode | String | کد پاسخ اپراتور |
operatorResponseMsg | String | متن پاسخ اپراتور |
نمونه پاسخ موفق:
جدول کدهای خطا
کد خطا | نوع | توضیحات |
1 | Validity Response Error | شکل کلی پارامترهای ورودی نادرست است |
31100 | Error on Request parameters | مقدار پارامتر ورودی valid نمی باشد |
31200 | mobile number is null | شماره موبایل مقداردهی نشده |
31300 | invoice number format is not valid | شماره موبایل نامعتبر است |
31400 | amount parameter is not valid | مقدار مبلغ نامعتبر است |
31500 | card number format is not valid | فرمت شماره کارت نامعتبر است |
31600 | username is not valid | کاربرمربوطه نامعتبر است |
31700 | validation error | خطا در اعتبارسنجی |
33500 | Not found | موجود نبودن پین در زمان خرید |
41100 | user has no authorization for the action | کاربر مربوطه دسترسی برای این عملیات ندارد |
41200 | operator access has been revoked | کاربر مربوطه دسترسی به این اپراتور ندارد |
41300 | service access has beenrevoked | سرویس مربوطه دسترسی به این اپراتور ندارد |
41400 | operator credit is not sufficient | اعتبار اپراتور مربوطه کافی نیست |
41500 | service credit is not sufficient | اعتبار سرویس مربوطه کافی نیست |
41600 | invoice number has been reserved | شماره فاکتور رزرو شده است |
41700 | there is a problem in invoice reservation | مشکل در رزرو شماره فاکتور وجود دارد |
50500 | Operator is not available | اپراتور در دسترس نیست |
1035- | - | اعمال شارژ برای مشترکین دایمی امکان پذیر نمی باشد |
23 | INVALID, Mobile no is inactive or not registered | - |
17001 | Your request cannot be processed at this time, please try again later | |
1112- | حداقل مبلغ خرید ۵۰۰۰ تومان می باشد |