3.8 KiB
3.8 KiB
API عمومی کاتالوگ کالا (شبکهٔ انتشار)
این APIها بدون احراز هویت Hesabix در دسترساند؛ روی IP نرخسنجی (rate limit) دارند.
مسیرها
| روش | مسیر | توضیح |
|---|---|---|
| GET | /api/v1/public/catalog/products |
لیست با search, business_id, category_id, province, city, brand, skip, take |
| GET | /api/v1/public/catalog/products/{catalog_public_uuid} |
جزئیات یک کالای منتشرشده (catalog_public_uuid باید UUID معتبر باشد) |
| GET | /api/v1/public/catalog/products/{catalog_public_uuid}/image |
تصویر کالا (`size=small |
| GET | /api/v1/public/catalog/feed.json |
فید سبک برای همگامسازی |
| POST | /api/v1/public/catalog/contact-messages |
ارسال پیام تماس؛ الزام کپچا (captcha_id, captcha_code همراه با POST /api/v1/auth/captcha برای دریافت تصویر) |
خطاها
پاسخهای خطای این ماژول (بهجز خطاهای داخلی نادر) معمولاً به شکل:
{ "success": false, "error": { "code": "...", "message": "..." } }
هستند (کد HTTP متناظر: 400، 404، 422، 429).
تنظیمات
- روی هر کالا/خدمت: فیلد
is_public_catalogدر ثبت/ویرایش؛ سرور در صورت نیازcatalog_public_uuidتولید میکند. فقط کالاهایی که UUID دارند در لیست عمومی میآیند. - پروفایل شبکهٔ تأمین (تب «شبکهٔ تأمین» در فرم کالا):
catalog_short_description— خلاصه کوتاهcatalog_expert_review— بررسی تخصصیcatalog_specifications— آرایهٔ{field_id?, label, value, sort_order}catalog_brand,catalog_model,catalog_country_of_origin,catalog_video_url- قالب فیلدهای مشخصات per-business:
GET/POST /api/v1/catalog-spec-fields/business/{id}
- روی کسبوکار:
public_catalog_show_contact— نمایشphone/mobileدر بلوکsupplier.public_catalog_show_base_sales_price— اگرfalseباشد، فیلدbase_sales_priceدر خروجی عمومیnullاست.
آدرس تصویر و سایت جانبی
فیلدهای image_url / thumbnail_url در JSON به صورت مسیر نسبی برگردانده میشوند؛ کلاینت باید با پایهٔ URL همان API (مثلاً https://api.example.com) ترکیبشان کند.
مهاجرت
alembic upgrade head برای اعمال بهترتیب:
20260620_000001_product_public_catalog20260621_000001_public_catalog_price_flag20260709_000001_product_supply_network_catalog20260710_000001_product_catalog_gallery
فیلدهای اضافی در خروجی جزئیات (GET .../products/{uuid})
علاوه بر فیلدهای پایه، در بلوک product ممکن است اینها هم باشند:
| فیلد | توضیح |
|---|---|
short_description |
خلاصه کوتاه کاتالوگ |
expert_review |
بررسی تخصصی (HTML) |
specifications |
آرایهٔ {label, value, field_id?, sort_order} |
brand, model, country_of_origin, video_url |
مشخصات تکمیلی |
gallery_urls, gallery_thumbnail_urls |
تصاویر گالری |
min_order_qty, lead_time_days |
از فیلدهای موجودی/سفارش کالا |
جستجو و فیلتر
- پارامتر
searchروی نام، توضیحات، خلاصه، بررسی تخصصی، برند، مدل، کشور سازنده و متن JSON مشخصات فنی جستجو میکند. - پارامتر
brandبرای فیلتر برند/مدل (اختیاری).