خطاها و محدودیت‌ها
قالب یکسان خطاها، فهرست کامل کدها با معنی و راه حل، و محدودیت‌های نرخ و اندازه.
قالب خطا
همه سرویس‌های نمایک خطا را با یک قالب برمی‌گردانند: وضعیت HTTP، کد ثابت انگلیسی برای برنامه و پیام فارسی آماده نمایش. برخی خطاها کلیدهای جزئیات هم دارند (مثلا param یا index). خطاها هرگز کش نمی‌شوند و هرگز هزینه ندارند.
{ "success": false, "statusCode": 403, "code": "ORIGIN_NOT_ALLOWED", "message": "این دامنه برای کلید مجاز نیست"}خطاهای کلید
این خطاها در همه سرویس‌ها (نقشه، API عمومی و پشتیبان‌گیری) یکسان‌اند و به همین ترتیب بررسی می‌شوند:
| ترتیب | کد | HTTP | معنی و اقدام |
|---|---|---|---|
| 1 | KEY_MISSING | 401 | کلید API ارسال نشده استکلید را با ?key= (فقط کلید عمومی)، سرآیند X-Namayek-Key یا Authorization: Bearer بفرستید. |
| 2 | KEY_INVALID | 401 | کلید API نامعتبر استکلید را کامل و بی فاصله کپی کنید؛ قالب درست nmk_pk_ یا nmk_sk_ و ۴۰ نویسه است. |
| 3 | SECRET_KEY_IN_URL | 400 | کلید محرمانه نباید در نشانی ارسال شودکلید محرمانه را فقط در سرآیند بفرستید و چون در نشانی دیده شده، همان را بچرخانید. |
| 4 | KEY_REVOKED | 401 | کلید API باطل شده استکلید تازه بسازید یا کلید جانشین چرخش را به کار ببرید. |
| 5 | KEY_EXPIRED | 401 | کلید API منقضی شده استکلید تازه با تاریخ انقضای دیرتر بسازید. |
| 6 | ACCOUNT_LOCKED | 403 | حساب مالک کلید مسدود استبا پشتیبانی نمایک تماس بگیرید. |
| 7 | PROJECT_DISABLED | 403 | پروژه این کلید غیرفعال استپروژه را در پنل فعال کنید یا با پشتیبانی تماس بگیرید. |
| 8 | BROWSER_USE_FORBIDDEN | 403 | کلید محرمانه در مرورگر مجاز نیستدر مرورگر کلید عمومی بگذارید؛ کلید محرمانه فقط روی سرور شما. |
| 9 | ORIGIN_NOT_ALLOWED | 403 | این دامنه برای کلید مجاز نیستدامنه صفحه (مثلا https://www.example.com) را به دامنه‌های مجاز کلید اضافه کنید. |
| 10 | IP_NOT_ALLOWED | 403 | این IP برای کلید مجاز نیستIP خروجی سرورتان را به فهرست IP کلید اضافه کنید. |
| 11 | SCOPE_DENIED | 403 | این کلید به این سرویس دسترسی ندارددسترسی لازم (مثلا maps:routing) را به کلید بدهید. |
| 12 | ACCOUNT_SUSPENDED | 402 | سرویس به دلیل بدهی متوقف استکیف پول را شارژ کنید؛ سرویس فورا برمی‌گردد. |
| 13 | SPEND_CAP_REACHED | 402 | سقف هزینه پروژه پر شده استسقف هزینه پروژه را بالا ببرید یا تا ماه بعد صبر کنید. |
| 14 | DAILY_CAP_REACHED | 429 | سقف روزانه کلید پر شده استتا نیمه‌شب تهران صبر کنید یا سقف روزانه کلید را بالا ببرید.Retry-After: ثانیه تا نیمه‌شب تهران |
| 15 | RATE_LIMITED | 429 | تعداد درخواست بیش از حد مجاز استسرعت را کم کنید و پس از Retry-After دوباره بفرستید.Retry-After: 1 |
| 16 | KEY_LOOKUP_UNAVAILABLE | 503 | سرویس موقتا در دسترس نیستبا فاصله رو به افزایش دوباره تلاش کنید. |
خطاهای API
| کد | HTTP | معنی و اقدام |
|---|---|---|
VALIDATION | 400 | متن خطای اعتبارسنجیبدنه یا کوئری را با جدول همان مسیر تطبیق دهید؛ فیلد ناشناخته پذیرفته نمی‌شود.message |
KEY_NOT_FOUND | 404 | کلید پیدا نشدkeyId باید از همین پروژه باشد. |
INVALID_PERIOD | 400 | ماه انتخاب شده معتبر نیستبازه from و to را درست بفرستید (ساعتی تا ۷ روز، روزانه تا ۴۰۰ روز). |
WEBHOOK_NOT_FOUND | 404 | وب هوک پیدا نشدشناسه وب‌هوک را از GET /v1/webhooks بگیرید. |
WEBHOOK_URL_INVALID | 400 | نشانی وب هوک معتبر نیستنشانی https کامل بدهید.reason |
WEBHOOK_URL_BLOCKED | 400 | این نشانی به شبکه داخلی اشاره می کند و مجاز نیستنشانی عمومی اینترنتی بدهید. |
WEBHOOK_LIMIT_REACHED | 409 | به سقف تعداد وب هوک های این پروژه رسیده ایدوب‌هوک بی‌استفاده را حذف کنید. |
WEBHOOK_EVENT_UNKNOWN | 400 | رویداد انتخاب شده معتبر نیستنام رویداد را از جدول رویدادها بردارید. |
WEBHOOK_DISABLED | 409 | این وب هوک غیرفعال استاول وب‌هوک را با status: active فعال کنید. |
RATE_LIMITED | 429 | تعداد درخواست بیش از حد مجاز استسقف درخواست هر کلید و هر گروه مسیر را مدیر سکو تعیین می‌کند (پیش‌فرض ۶۰ در دقیقه)؛ پس از زمان Retry-After دوباره تلاش کنید.Retry-After: ثانیه تا پنجره بعد |
خطاهای سرویس‌های نقشه در خطاهای نقشه آمده‌اند.
تلاش دوباره
429و503: پس ازRetry-After(ثانیه) دوباره بفرستید.502و504: یک بار با فاصله کوتاه دوباره تلاش کنید.- ۴xx دیگر را دوباره نفرستید؛ درخواست یا تنظیمات را درست کنید.
402: کیف پول را شارژ یا سقف هزینه را بالا ببرید.
محدودیت‌ها
- درخواست در ثانیه هر کلید: پیش‌فرض ۵۰ (عمومی) و ۱۰۰ (محرمانه)، قابل تغییر برای هر کلید.
- سقف روزانه هر کلید و سقف هزینه روزانه و ماهانه هر پروژه: اختیاری، در پنل.
- API عمومی: سقف هر کلید و هر گروه مسیر از پنل مدیریت تنظیم می‌شود (پیش‌فرض ۶۰ درخواست در دقیقه؛ ساخت توکن ویجت ۶۰۰).
- طول نشانی درخواست نقشه: حداکثر ۸۱۹۲ بایت.
- محدودیت‌های هر سرویس نقشه در محدودیت‌ها و هزینه نقشه.
آخرین به‌روزرسانی: