مستندات وبسرویس
(v1.0)کدهای خطا
در این صفحه، لیست کاملی از کدهای خطای API گیفت سیتی و توضیحات آنها ارائه شده است. هر پاسخ خطای API شامل یک کد خطای منحصر به فرد است که به شما در شناسایی و رفع مشکل کمک میکند.
فرمت پاسخهای خطا
تمام پاسخهای خطای API گیفت سیتی دارای ساختار یکسان زیر هستند:
ساختار پاسخ خطا
{
"status": "error",
"code": 1001,
"message": "پیام خطا",
"meta": {
// اطلاعات اضافی در مورد خطا (اختیاری)
}
}
جدول کدهای خطا
کد خطا | پیام | توضیحات |
---|---|---|
1001 | کلید API ارائه نشده است | هدر X-API-KEY در درخواست وجود ندارد |
1001 | کلید API نامعتبر است | کلید API ارائه شده معتبر نیست یا منقضی شده است |
1002 | محدودیت تعداد درخواست | تعداد درخواستهای شما از حد مجاز (60 درخواست در دقیقه) بیشتر شده است |
1003 | دسترسی از این IP مجاز نیست | آدرس IP درخواستدهنده در لیست IPهای مجاز قرار ندارد |
1004 | موجودی کیف پول کافی نیست | موجودی کیف پول شما برای پرداخت این سفارش کافی نیست |
1005 | محصول یافت نشد | محصول مورد نظر در سیستم وجود ندارد یا غیرفعال شده است |
1006 | محصول موجود نیست | محصول مورد نظر در حال حاضر موجود نیست (out of stock) |
1007 | پارامترهای ورودی نامعتبر | پارامترهای ارسال شده نامعتبر هستند. جزئیات در meta قابل مشاهده است |
1008 | فیلدهای مورد نیاز تکمیل نشدهاند | فیلدهای مورد نیاز برای ثبت سفارش تکمیل نشدهاند |
1009 | سفارش یافت نشد | سفارش مورد نظر در سیستم وجود ندارد یا متعلق به شما نیست |
500 | خطای داخلی سرور | یک خطای داخلی در سرور رخ داده است. لطفاً با پشتیبانی تماس بگیرید |
نمونههای خطا
خطای احراز هویت
{
"status": "error",
"code": 1001,
"message": "کلید API نامعتبر است"
}
خطای کمبود موجودی
{
"status": "error",
"code": 1004,
"message": "موجودی کیف پول کافی نیست",
"meta": {
"currentBalance": 50000,
"requiredAmount": 120000
}
}
خطای پارامترهای نامعتبر
{
"status": "error",
"code": 1007,
"message": "پارامترهای ورودی نامعتبر",
"meta": {
"errors": [
{
"field": "products[0].regionPropertyId",
"message": "شناسه ویژگی منطقه نامعتبر است"
},
{
"field": "requiredFields",
"message": "فیلدهای مورد نیاز باید ارائه شوند"
}
]
}
}
نکات مهم در مورد مدیریت خطاها
- همیشه کد خطا را برای شناسایی دقیق مشکل بررسی کنید، نه فقط پیام خطا.
- در صورت دریافت خطای کمبود موجودی (1004)، کیف پول خود را شارژ کنید.
- برای خطاهای 1007 و 1008، به بخش meta دقت کنید تا متوجه شوید دقیقاً کدام پارامترها نامعتبر هستند.
- در صورت دریافت خطای 500 (خطای داخلی سرور)، لطفاً با پشتیبانی تماس بگیرید.