ساخت api محصولات ووکامرس برای سایت ترب

شرح پروژه

با سلام 

یک api لازم دارم برای سایت ترب که مستندات فنی را در ذیل آوردم .

روش اول: خروجی json¶

در این روش بهتر است از متد GET برای دریافت محصولات استفاده شود.

پارامترهای مورد نیاز در api:¶

{ product_id: '...', page_url: '...', price: '...', availability: '...', old_price: '...', }

ملاحظات:¶

1. در مورد product_id یا شناسه محصول، محصولات شما با این شناسه در موتور جست‌و‌جوی ترب شناخته می‌شوند. بنابراین انتظار می‌رود که این شناسه برای هر محصول منحصر‌به‌فرد و یکتا بوده، ثابت و بدون تغییر باقی بماند.
2. منظور از price قیمت اصلی محصول است که در سایت محصول به این قیمت فروخته می‌شود و برای محصولات تخفیف خورده، منظور قیمت پس از تخفیف است.
3. مقدار availability نشان‌دهنده‌ي موجود‌بودن یا نبودن محصول در سایت است. برای بیان موجودبودن محصول باید از مقدار 'instock' استفاده شود.
4. منظور از old_price قیمت قدیم محصولات تخفیف خورده است.
5. توجه به این نکته بسیار ضروری و مهم است که اطلاعات موجود در صفحه محصول و اطلاعات موجود در این api نباید باهم تفاوت داشته باشند.
6. محصولات در صفحه‌ی موردنظر، به ترتیب جدید به قدیم مرتب شوند.

شماره ۲ : اضافه شدن محصولات با استفاده از api¶

در صورت امکان برای اضافه شدن و بروزرسانی اطلاعاتِ محصولات در ترب می‌توانید یک api با فرمتی که در ادامه توضیح داده شده فراهم نمایید و آن را از طریق پنل پشتیبانی به ما اطلاع دهید.

روش درخواست به api:¶

• متد درخواست: POST
• آدرس درخواست: https://domain.com/{anything}/products
  قسمت {anything} بدین معناست که فقط نیاز است آخرین دایرکتوری برابر products باشد و قبل از آن به انتخاب شما هر مسیر و مقداری می تواند داشته باشد.

ورودی:

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

خروجی:

در این api دو نوع خروجی تصور شده است.

• اگر هیچ پارامتری ارسال نشود یا فقط پارامتر page ارسال شود، خروجی برابر لیست محصولات خواهد بود که قالب آن در ادامه توضیح داده شده است.
• اگر یکی از دو ورودی page_unique یا page_url ارسال شود، محصول متناظر با همان شناسه یا لینک محصول در خروجی نمایش داده خواهد شد.

قالب خروجی api:¶

{ "count": "150", "max_pages": "2", "products": [ { "title": "گوشی موبایل شائومی Note 10 Pro", "subtitle": "Xiaomi Mi Note 10 Pro" "page_unique": "12412", "current_price": "5000000", "old_price": "5500000", "availability": "instock", "category_name": "mobile", "image_link": "https://domain.com/images/test.jpg", "page_url": "https://domain.com/product/34/", "short_desc": "دارای سنسور تشخیص چهره", "spec": { "memory": "4GB", "camera": "12 مگاپیکسل", "color": "سفید", ... }, "registry": "رجیستر شده", "guarantee": "گارانتی 24 ماه سازگار" }, ... } توضیح خروجی api:¶

• count: تعداد کل محصولات
• max_pages: تعداد کل صفحات با در نظر گرفتن ۱۰۰ محصول در هر صفحه
• title: عنوان محصول
• subtitle: زیرعنوان (معمولا نام انگلیسی محصول) (اختیاری)
• page_unique: شناسه اختصاصی و غیرتکراری محصول
• current_price: قیمت فروش
• old_price: قیمت قبل از تخفیف (اختیاری)
• availability: وضعیت موجودی. برای بیان موجود بودن محصول از مقدار instock استفاده فرمایید.
• category_name: دسته بندی (اختیاری)
• image_link: آدرس تصویر محصول
• page_url: آدرس محصول
• short_desc: توضیح مختصر در مورد محصول (اختیاری)
• spec: آرایه ای از عناوین و مقادیر ویژگی ها (اختیاری). در این آرایه هر ویژگی به صورت نام و مقدار گنجاده می شود. هم نام و هم مقدار می توانند انگلیسی یا فارسی باشند.
• registry: رجیستری. اگر محصول رجیستر شده است از مقدار رجیستر شده و در غیر اینصورت از مقدار رجیستر نشده استفاده فرمایید (اختیاری).
• guarantee: گارانتی محصول (اختیاری)

ملاحظات:¶

1. محصولات باید به ترتیب جدید به قدیم مرتب شوند.
2. مواردی که اختیاری هستند، نیازی به پیاده سازی ندارند ولی در صورت عدم پیاده سازی ممکن است تایید و دسته بندی آن ها با تاخیر روبرو شود.
3. در هر صفحه از خروجی انتظار می رود، ۱۰۰ محصول نمایش داده شوند.
4. رجیستری فقط برای محصولات موبایل کاربرد دارد.
5. دقت فرمایید از همین روش برای تک محصول نیز باید استفاده شود، یعنی در صورتی که لینک یا شناسه‌ی محصول برای api ارسال گردد، اطلاعات مربوطه در لیستی که حاوی یک محصول است نمایش داده شود.
6. پارامترها به صورت form-data ارسال خواهند شد.
7. ممکن است به آخر لینک ها پارامترهایی مانند utm اضافه شود، در نتیجه هنگام درخواست مشخصات محصول از طریق لینک محصول این پارامترها نباید باعث خطا و عدم ارسال پاسخ شوند. برای مثال لینک روبرو باید مشابه لینک اصلی محصول تعبیر شود: https://domain.com/product/example?utm_medium=PPC&utm_source=Torob

مهارت ها و تخصص های مورد نیاز

درباره کارفرما

کاربر328465

عضویت دو سال پیش

1 پروژه ثبت شده ،

0 پروژه در حال انجام ،

0 پروژه آماده دریافت پیشنهاد ،

نرخ پذیرش پیشنهاد 0%