مستندات APIرفتن به اتاق پرو
CHECKSTYLE API

مستندات API

افزونه چک‌استایل برای ووکامرس

دکمه پرو مجازی را به صفحه محصولات فروشگاهت اضافه کن. پس از نصب، کلید API فروشگاه را در تنظیمات افزونه وارد کن.

نسخه ۰.۶.۰ · وردپرس ۶.۵+، PHP ۷.۴+ و ووکامرس
دانلود افزونه ووکامرس

دریافت کلید

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

درخواست ساخت تصویر

دو عکس JPG، PNG یا WebP با حجم حداکثر ۵ مگابایت را به‌صورت Data URL بفرست. پاسخ در همان درخواست برمی‌گردد؛ زمان انتظار کلاینت را دست‌کم ۱۸۰ ثانیه بگذار.

POST https://checkstyle.ir/api/v1/try-on
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "person_image": "data:image/jpeg;base64,BASE64_PERSON",
  "garment_image": "data:image/jpeg;base64,BASE64_GARMENT"
}

برای ارسال فایل‌ها، محتوای هر عکس را Base64 کن و پیشوند متناسب با نوع فایل را به آن اضافه کن؛ مثلاً data:image/png;base64,.

نمونه فراخوانی

curl https://checkstyle.ir/api/v1/try-on \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

پاسخ موفق

{
  "image": "data:image/png;base64,...",
  "credits_remaining": 4
}

فیلد image یک Data URL است؛ آن را مستقیم در تصویر نمایش بده یا بخش Base64 را برای ذخیره فایل رمزگشایی کن. نوع تصویر خروجی می‌تواند PNG، JPEG یا WebP باشد.

پردازش مرحله‌ای

برای اتصال فروشگاه‌ها و هاست‌هایی که زمان پاسخ کوتاه دارند، همان درخواست را به مسیر زیر بفرست. پاسخ اولیه با کد ۲۰۲ یک شناسه درخواست می‌دهد؛ سپس وضعیت را با همان کلید API پیگیری کن.

POST /api/v1/try-on?async=1
→ { "token": "REQUEST_ID", "status": "processing" }

GET /api/v1/status/REQUEST_ID
Authorization: Bearer YOUR_API_KEY
→ { "status": "processing" }
→ { "status": "completed", "image": "data:image/png;base64,..." }

خطاهای رایج

  • 400 تصاویر یا قالب درخواست نامعتبر است.
  • 401 کلید نامعتبر یا لغوشده است.
  • 402 اعتبار حساب کافی نیست.
  • 502/503 ساخت تصویر یا سرویس موقتاً در دسترس نیست؛ اعتبار مصرف نمی‌شود.