مستندات خطاها و تلاش مجدد
برای خطاها آماده باشید.
خطاها با کد وضعیت HTTP و یک شیء error در بدنه پاسخ برمی‌گردند.
کدهای رایج
| کد | معنی | اقدام |
|---|---|---|
| 400 | درخواست نامعتبر | پارامترها و بدنه درخواست را بررسی کنید. |
| 401 | کلید نامعتبر | وجود کلید و درست بودن هدر Authorization را بررسی کنید. |
| 403 | اعتبار ناکافی یا رسیدن به سقف مصرف کلید | موجودی حساب را شارژ کنید یا سقف مصرف کلید را افزایش دهید. |
| 404 | مسیر یا مدل ناموجود | آدرس پایه و شناسه مدل را بررسی کنید. |
| 429 | عبور از محدودیت | کمی صبر کنید و با فاصله افزایشی دوباره تلاش کنید. |
| 5xx | خطای موقت سرویس | با تعداد تلاش محدود دوباره امتحان کنید. |
ساختار پاسخ خطا
خطاها یک شیء error شامل message (پیام) و type (نوع) برمی‌گردانند. هنگام تماس با پشتیبانی، کل پیام را بفرستید؛ اگر شناسه درخواست (request id) در آن باشد، همراهش بفرستید.
{
"error": {
"message": "Invalid Cyno API key (request id: 2026...)",
"type": "cyno_error"
}
}تلاش مجدد با احتیاط
فقط خطاهای 429 و 5xx را دوباره امتحان کنید؛ با تأخیر تصاعدی، کمی تغییر تصادفی و سقف مشخص. خطاهای 400، 401 و 403 با تکرار درست نمی‌شوند.