راهنمای پیاده سازی API جهت استخراج محصولات توسط ربات ذره بین

اضافه شدن محصولات با استفاده از API

شرح API:

در صورت امکان برای اضافه شدن و بروزرسانی اطلاعاتِ محصولات در ذره بین، می‌توانید یک API با فرمت زیر فراهم نموده و آدرس آن را از طریق تیکت برای پشتیبانی ارسال نمایید. (در صورت عدم دانش جهت انجام این کار، با یک برنامه نویس صحبت نمایید.)

ورودی:

• شناسه محصول (product_id) : شناسه ی یکتای محصول می باشد که از طریق همین API در اختیار ربات قرار گرفته است.

• شماره صفحه (page) : پارامتر page در صورتی که ارسال نشود برابر با یک است و برای صفحات بعدی این پارامتر ارسال خواهد شد.

خروجی:

• نوع اول: اگر پارامتری ارسال نشود یا فقط پارامتر page ارسال شود،آنگاه خروجی برابر لیست محصولات با قالب زیر خواهد بود.

• نوع دوم: یکی از دو ورودی product_id ارسال شود، آنگاه در خروجی محصول متناظر با همان شناسه یا لینک محصول نمایش داده خواهد شد.

توضیح خروجی API:

• count: این پارامتر تعداد کل محصولات می باشد.
• total_pages_count: این پارامتر تعداد کل صفحات با در نظر گرفتن ۱۰۰ محصول در هر صفحه می باشد.
• title: این پارامتر عنوان محصول می باشد.
• subtitle: این پارامتر زیرعنوان محصول(معمولا نام انگلیسی) و پارامتری اختیاری می باشد.
• id: این پارامتر شناسه اختصاصی و غیرتکراری محصول می باشد. (محصولات شما با این شناسه در ذره بین شناسایی می شوند و نباید در سایت شما تغییر پذیر باشند!)
• current_price: این پارامتر قیمت فروش محصول می باشد.
• old_price: این پارامتر قیمت قبل از تخفیف محصول و پارامتری اختیاری می باشد.
• availability: این پارامتر وضعیت موجودی محصول می باشد. برای بیان موجود بودن محصول از مقدار instock استفاده فرمایید.
• page_url: این پارامتر آدرس محصول می باشد. (آدرس به صورت کامل بازگردانده شود. برای مثال: https://www.yourdomain.com/product/abc )
• categories: این پارامتر شامل دسته بندی های محصول شامل دسته بندی اصلی و زیر دسته می باشد.
• image_link: این پارامتر آدرس تصویر اصلی محصول می باشد. (آدرس به صورت کامل بازگردانده شود. برای مثال: https://www.yourdomain.com/images/img_abc.jpg )
• image_links: این پارامتر یک لیست از آدرس تصاویر محصول می باشد.(شامل تصویر اصلی)
• spec: این پارامتر دیکشنری ای از عناوین و مقادیر ویژگی های محصول و پارامتری اختیاری می باشد. در این دیکشنری هر ویژگی به صورت نام و مقدار گنجاده می شود. هم نام و هم مقدار می توانند انگلیسی یا فارسی باشند. در صورتی که یک ویژگی با چند مقدار در سایتان وجود داشت، می توانید مقادیر را به وسیله ویرگول بهم متصل کنید تا دیکشنری شامل دو کلید هم نام نباشد.
• short_desc: این پارامتر توضیح مختصر در مورد محصول و پارامتری اختیاری می باشد.

   

  قالب خروجی API:

  {
       "count": "500",
       "total_pages_count": "8",
       "products": [
          {
              "title": "گوشی سامسونگ s22 ultra",
              "subtitle": "samsung s22 ultra",
              "id": 13452,
              "current_price": "35000000",
              "old_price": "36000000",
              "availability": "instock",
              "categories": ["mobile", "samsung"],
              "image_link": "https://yourdomain.com/images/samsung.jpg",
              "image_links": [
                  "https://yourdomain.com/images/samsung1.jpg",
                  "https://yourdomain.com/images/samsung2.jpg",
              ],
              "page_url": "https://yourdomain.com/product/5654/",
              "short_desc": "گوشی سامسونگ با اثر انگشت",
              "spec": {
                  "memory": "16GB",
                  "camera": "100 مگاپیکسل",
                  "color": "مشکی",
              },
              "registry": "رجیستر شده",
              "guarantee": "گارانتی 36 ماه سام سرویس"
          },
      ]
  }
  
  

   

   

  توجه:

  * لطفا برای title و subtitle محدودیت ۵۰۰ کاراکتری و برای image_link محدودیت ۱۰۰۰ کاراکتری نیز در نظر بگیرید.

  * در هر صفحه از خروجی انتظار می رود، ۱۰۰ محصول نمایش داده شوند.

  * در صورتی که محصولات در سایت شما با شناسه (id) غیر عددی (رشته ای، GUID و ...) شناخته می شوند. شناسه محصول را در نتایج بازگشتی به صورت رشته برگردانید.

  * پارامترها در فرمت QueryString ارسال خواهند شد.

  * دقت فرمایید از همین روش برای تک محصول نیز باید استفاده شود، یعنی در صورتی که لینک یا شناسه‌ی محصول برای API ارسال گردد، اطلاعات مربوطه در لیستی که حاوی یک محصول است نمایش داده شود.

  * مواردی که اختیاری هستند، نیازی به پیاده سازی ندارند ولی در صورت عدم پیاده سازی ممکن است تایید و دسته بندی آن ها با تاخیر روبرو شود.

  * محصولات در صفحه‌ی موردنظر، به ترتیب جدید به قدیم مرتب شوند. یعنی محصولات جدیدا اضافه شده و جدیدا ویرایش شده در اولویت قرار داشته باشند.