آخرین بروز رسانی: 25 مرداد 1397 11:13:48
وب سرویس (آزمایشی - دوستان در آینده برای استفاده از وب سرویس باید ثبت نام کنید)

در سایت، وبلاگ یا اپلیکیشن موبایلی خود جستجوگر پیشواز قرار دهید

همان طور که شاید تا به حال شنیده باشید API (رابط برنامه نویسی اپلیکیشن) مخفف عبارت Application Programming Interface می باشد که به برنامه نویسان امکان رد و بدل کردن اطلاعات مابین پلتفرم های مختلف را از طریق ارسال یک درخواست HTTP(S) ساده و فراخوانی متد های مورد نظر می دهد.
حال فرض کنید در خواست مورد نظر اطلاعات مربوط به جستجوی پیشواز باشد و جواب آن نتیجه و پیشوازهای یافت شده باشد .
وب سرویس پیشواز کده متن مورد جستجو را از طریق پارامتر ورودی در متد GET یا POST دریافت می کند و خروجی را به فرمت های json و xml برگشت می دهد.
نکته: جهت آشنائی با JSON می توانید با مراجعه به سایت www.json.org هم از ساختار فرمت آن مطلع شوید و هم درایور مربوط به زبان برنامه نویسی مورد نظر خود را دریافت نمائید.
نکته: کلیه فیلد های تاریخ در وب سرویس پیشواز کده به فرمت UnixTime می باشد . برای آشنائی با فرمت UnixTime می توانید به آدرس https://en.wikipedia.org/wiki/Unix_time مراجعه کنید.

متد ها

از این متد برای جستجوی پیشواز استفاده می کنیم.
• ساختار URL (پیش فرض): پارامترهای ورودی:
• type  اجباری  نمایش می دهد xml و json خروجی را به فرمت های
• category  اختیاری  (irancell,hamrahe-aval,rightel شامل یکی از موارد) دسته بندی
• value  اجباری  متن مورد جستجو
• ساختار URL (لیستی): پارامترهای ورودی:
• type  اجباری  نمایش می دهد xml و json خروجی را به فرمت های
• browse  اجباری  (listed) نوع مرور کردن
• index  اجباری  از کدام سطر شروع شود
• count  اجباری  تعداد سطر در خروجی
• category  اختیاری  (irancell,hamrahe-aval,rightel شامل یکی از موارد) دسته بندی
• value  اجباری  متن مورد جستجو
پارامترهای خروجی:
• version  Integer  api نگارش
• value  String  متن مورد جستجو
• browse  String  (default,listed شامل یکی از موارد) نوع مرور کردن
• category  String  (irancell,hamrahe-aval,rightel شامل یکی از موارد) دسته بندی
• rowCount  Integer  تعداد سطر یافت شده
• link  String  لینک صفحه جستجو در پیشواز کده
خروجی آرایه ای از ساختار زیر خواهد بود.
• rowNumber  Integer  شماره سطر
• id  String  شناسه یکتای پیشواز
• title  String  عنوان اثر
• singer  String  صاحب اثر
• code  Integer  کد فعال سازی
• category  String  دسته بندی
• price  Integer  قیمت (ریال)
• validity  Integer  اعتبار (روز)
• info  String  توضیحات / آلبوم
• image  String  آدرس تصویر
• tone  String  آدرس آهنگ
• totalView  Integer  بیشترین بازدید
• publishedTime  UnixTime  UnixTime زمان انتشار به فرمت
• reviewTime  UnixTime  UnixTime زمان بررسی فعال بودن پیشواز به فرمت
• link  String  لینک کوتاه پیشواز
مثال:
{
"return": {
"version": 1,
"value": "محمد رضا شجریان",
"browse": "default",
"category": null,
"rowCount": 2,
"link": "http://www.pishvazkade.ir/result/%d9%85%d8%ad%d9%85%d8%af+%d8%b1%d8%b6%d8%a7+%d8%b4%d8%ac%d8%b1%db%8c%d8%a7%d9%86"
},
"result": [
{
"rowNumber": 1,
"id": "r90ok",
"title": "تصنیف دوش دوش (1)",
"singer": "محمدرضا شجریان",
"code": 45891,
"category": "همراه اول",
"price": 3000,
"validity": 30,
"info": "آرام جان",
"image": "http://www.pishvazkade.ir/upload/singer/lmzce/qenrf.jpg",
"tone": null,
"totalView": 2335,
"publishedTime": 1477207707.0,
"reviewTime": 1521833400.0,
"link": "http://www.pishvazkade.ir/go/r90ok"
},
{
"rowNumber": 2,
"id": "e0bml",
"title": "تصنیف بت چین (1)",
"singer": "محمدرضا شجریان",
"code": 46180,
"category": "همراه اول",
"price": 3000,
"validity": 30,
"info": "راست پنجگاه",
"image": "http://www.pishvazkade.ir/upload/singer/lmzce/qenrf.jpg",
"tone": null,
"totalView": 1736,
"publishedTime": 1469935951.0,
"reviewTime": 1521833400.0,
"link": "http://www.pishvazkade.ir/go/e0bml"
}
]
}
از این متد برای بدست آوردن اطلاعات پیشواز استفاده می کنیم.
• ساختار URL: پارامترهای ورودی:
• type  اجباری  نمایش می دهد xml و json خروجی را به فرمت های
• id  اجباری  شناسه یکتای پیشواز (شناسه 5 رقمی مقابل کلمه go/ که در لینک کوتاه موجود است)
پارامترهای خروجی:
• version  Integer  api نگارش
• id  String  شناسه یکتای پیشواز
خروجی محتوا ساختار زیر خواهد بود.
• title  String  عنوان اثر
• singer  String  صاحب اثر
• code  Integer  کد فعال سازی
• category  String  دسته بندی
• price  Integer  قیمت (ریال)
• validity  Integer  اعتبار (روز)
• info  String  توضیحات / آلبوم
• image  String  آدرس تصویر
• tone  String  آدرس آهنگ
• totalView  Integer  بیشترین بازدید
• publishedTime  UnixTime  UnixTime زمان انتشار به فرمت
• reviewTime  UnixTime  UnixTime زمان بررسی فعال بودن پیشواز به فرمت
• link  String  لینک کوتاه پیشواز
مثال:
{
"return": {
"version": 1,
"id": "r90ok"
},
"content": {
"title": "تصنیف دوش دوش (1)",
"singer": "محمدرضا شجریان",
"code": 45891,
"category": "همراه اول",
"price": 3000,
"validity": 30,
"info": "آرام جان",
"image": "http://www.pishvazkade.ir/upload/singer/lmzce/qenrf.jpg",
"tone": null,
"totalView": 2339,
"publishedTime": 1477207707.0,
"reviewTime": 1521833400.0,
"link": "http://www.pishvazkade.ir/go/r90ok"
}
}
2015 © کلیه حقوق این وبسایت متعلق به پیشواز کده می باشد.