مقدمه
برای شارژ تلفن همراه خود میتوانید از این سرویس شارژ استفاده کنید.
فعالسازی سرویس
ارسال درخواست در سایت پادیوم www.podium.ir:
ابتدا وارد سایت پادیوم شده، سپس در بازارچه‌ی API، سرویسهای مورد نظر خود را انتخاب و درخواست استفاده از آن مجموعه سرویس را ارسال کنید.
درخواست شما توسط کارشناسان پادیوم، بررسی شده و بعد از تایید آن میتوانید از طربق پنل کسب و کار خود اقدام به دریافت کلید اتصال مربوط به آن سرویس نمایید.
منو: پنل کسب و کار – منوی میزکار سرویس گیرنده – درخواستهای ارسالی – در بخش مربوط به سرویس مورد نظر با کلیک بر روی "جزئیات درخواست"
درلیست باز شده با کلیک بر روی تصویر کلید سمت چپ هر سطر جدول میتوانید ApiKey مربوط به آن سرویس را دریافت و ذخیره کنید.
لینک پنل کسب و کار https://panel.pod.ir/Businesses/Requestwebservices
نکته : این کلید در تمام درخواستهای ارسالی از آن سرویس ، ثابت است تا زمانی که کلید جدیدی برای آن سرویس دریافت نشود و به محض دریافت مقدار جدید برای سرویس مورد نظر, کلید قبلی منقضی خواهد شد.
-این کلید در فیلد scApiKey در بخش body درخواست HTTP ، استفاده می شود.
دریافت کلیدهای سرویس یک (دسته/مجموعه) سرویس در قالب یک فایل:
بعداز فشردن دکمه ی تایید سرویس در پنجره باز شده بالا ، برای تمامی سرویسهای موجود در پنل میتوانید از گزینه "دریافت فایل خروجی"، لیست کاملی از سرویس‌ها و کلیدهای scApiKey متناظر با هر یک را دریافت کنید.
سرویس دریافت توکن
برای استفاده از وب سرویس هایی که در ادامه آورده شده، ابتدا باید وب سرویس دریافت توکن را فراخوانی کرد
شناسهی سرویس:
o اصلی: 47512
o سندباکس:
پارامترهای ورودی:
پارامتر | نوع | اختیاری/ اجباری | توضیحات |
scProductId | string | اجباری | شناسهی سرویس |
scApiKey | string | اجباری | توکن |
فیلدهای خروجی:
بدنه‌ی اصلی پاسخ دریافتی در صورت فراخوانی موفق دارای ساختار زیر است:
فیلد | نوع | توضیحات |
hasError | Boolean | نتیجه موفق یا ناموفق |
messageId | string | |
message | string | |
referenceNumber | string | کد پیگیری |
ott | string | |
errorCode | string | کد خطا |
result | json | طبق جدول result |
جدول result:
فیلد | نوع | توضیحات |
firstName | string | نام |
lastName | string | نام خانوادگی |
userId | string | شماره کاربری |
username | string | |
cellphoneNumber | string | |
financialLevel | json | financialLevel طبق جدول |
جدول financialLevel:
فیلد | نوع | توضیحات |
firstName | string | نام |
lastName | string | نام خانوادگی |
userId | string | شماره کاربری |
username | string | |
cellphoneNumber | string | |
financialLevel | json | financialLevel طبق جدول |
نمونه پاسخ موفق:
سرویس خرید شارژ
شناسهی سرویس:
o اصلی: 47513
o سندباکس:
پارامترهای ورودی:
پارامتر | نوع | اختیاری/ اجباری | توضیحات |
scProductId | string | اجباری | شناسهی سرویس |
scApiKey | string | اجباری | توکن |
mobileNumber | string | اجباری | شماره موبایل |
productCode | string | اجباری | کد کالا (مطابق جدول productCode ) |
amount | string | اجباری | مبلغ شارژ |
Authorization | String | اجباری | توکن گرفته شده از مرحله قبل مثال: Bearer ejvhfgcbncj |
جدول productCode:
مقدار | توضیحات |
93 | شارژ عادی ایرانسل |
97 | شارژ شگفت انگیز ایرانسل |
95 | شارژ همراه اول |
94 | شارژ عادی رایتل |
96 | شارژ شگفت انگیز رایتل |
فیلدهای خروجی:
بدنه‌ی اصلی پاسخ دریافتی در صورت فراخوانی موفق دارای ساختار زیر است:
فیلد | نوع | توضیحات |
hasError | Boolean | نتیجه موفق یا ناموفق |
messageId | string | |
message | string | |
referenceNumber | string | کد پیگیری |
ott | string | |
errorCode | string | کد خطا |
result | json | طبق جدول result |
جدول result
فیلد | نوع | توضیحات |
invoiceId | string | شماره فاکتوری که در درخواست شارژ ارسال شده بود |
responseCode | string | کد پاسخ درخواست |
responseMessage | string | متن پاسخ درخواست |
transactionId | string | شماره تراکنش اپراتور |
otherParams | string | اطلاعات جانبی (در صورتیکه نیاز به ارسال اطلاعات دیگری از سمت سرور به کلاینت باشد از این فیلد استفاده می شود که در حال حاضر nullمی باشد |
جدول result
فیلد | نوع | توضیحات |
invoiceId | string | شماره فاکتوری که در درخواست شارژ ارسال شده بود |
responseCode | string | کد پاسخ درخواست |
responseMessage | string | متن پاسخ درخواست |
transactionId | string | شماره تراکنش اپراتور |
otherParams | string | اطلاعات جانبی (در صورتیکه نیاز به ارسال اطلاعات دیگری از سمت سرور به کلاینت باشد از این فیلد استفاده می شود که در حال حاضر nullمی باشد |
نمونه پاسخ موفق:
سرویس لیست بسته های اینترنتی
شناسهی سرویس:
o اصلی: 47514
o سندباکس:
پارامترهای ورودی:
پارامتر | نوع | اختیاری/ اجباری | توضیحات | ||
scProductId | string | اجباری | شناسهی سرویس | ||
scApiKey | string | اجباری | توکن | ||
Page | string | اجباری | شماره صفحه را مشخص می سازد – مقدار پیش فرض یک می باشد | ||
size | string | اجباری |
| ||
Authorization | String | اجباری | توکن گرفته شده از مرحله قبل مثال: Bearer ejvhfgcbncj |
فیلدهای خروجی:
بدنه‌ی اصلی پاسخ دریافتی در صورت فراخوانی موفق دارای ساختار زیر است:
فیلد | نوع | توضیحات |
hasError | Boolean | نتیجه موفق یا ناموفق |
messageId | string | |
message | string | |
referenceNumber | string | کد پیگیری |
ott | string | |
errorCode | string | کد خطا |
result | json | طبق جدول 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 | ترافیک هدیه به مگابایت |
ü با ارسال productCode در سرویس خرید شارژ (شماره سرویس 47513) امکان فعالسازی بسته اینترنتی برای مشتری امکان پذیر می باشد.
جدول operatorCode:
عنوان | مقدار |
ایرانسل | 1 |
همراه اول | 2 |
رایتل | 3 |
معین | 5 |
شاتل | 6 |
تالیا | 7 |
فناپ موبایل | 8 |
آپتل | 13 |
جیرینگ | 1 |
جدول packageTimeCode:
عنوان | مقدار |
روزانه | 1 |
شبانه | 2 |
ترکیبی | 3 |
مناسبتی | 4 |
جدول simeType:
عنوان | مقدار |
دائمی | 1 |
اعتباری | 2 |
دائمی- اعتباری | 3 |
دیتا – دائمی | 4 |
دیتا – اعتباری | 5 |
نمونه پاسخ موفق:
سرویس جستجوی بسته اینترنت
شناسهی سرویس:
o اصلی: 2739661
o سندباکس:
پارامترهای ورودی:
پارامتر | نوع | اختیاری/ اجباری | توضیحات | ||
scProductId | string | اجباری | شناسهی سرویس | ||
scApiKey | string | اجباری | توکن | ||
operatorName | string | اجباری | نام اپراتور(مطابق جدول operatorName) | ||
duration | string | اجباری | بسته های ساعتی ، روزانه ، هفتگی ، ماهانه و ... مربوط به هریک از اپراتور ها را استخراج کنید(مطابق جدول duration) | ||
simCardType | string | اختیاری |
| ||
Authorization | String | اجباری | توکن گرفته شده از مرحله قبل مثال: 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 | Boolean | نتیجه موفق یا ناموفق |
messageId | string | |
message | string | |
referenceNumber | string | کد پیگیری |
ott | string | |
errorCode | string | کد خطا |
result | json | طبق جدول 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 | ترافیک هدیه به مگابایت |
نمونه پاسخ موفق: