پاسخ‌ها، خطاها و محدودیت نرخ

قرارداد پاسخ موفق و ناموفق REST API اینپی فای، کدهای HTTP، خطاهای اعتبارسنجی و سیاست retry.

پاسخ‌های موفق این API با status: true و پاسخ‌های کنترل‌شده ناموفق با status: false بازگردانده می‌شوند. داده اصلی معمولاً داخل data قرار دارد.

پاسخ موفق

{
  "status": true,
  "data": {}
}

کد	معنی
`200 OK`	درخواست انجام شد.
`201 Created`	منبع ایجاد شد؛ مانند مشتری جدید، override یا دسترسی تبلیغاتی.

کد	دلیل متداول	اقدام پیشنهادی
`401`	کلید وجود ندارد یا معتبر نیست	کلید و هدر Authorization را بررسی کنید.
`403`	کلید مجوز لازم را ندارد	ability کلید را بررسی کنید.
`404`	منبع در پروژه یا اپلیکیشن پیدا نشد	شناسه و محدوده پروژه را بررسی کنید.
`422`	body، پارامتر مسیر یا هدر معتبر نیست	فیلدهای خطای validation را اصلاح کنید.
`429`	محدودیت نرخ عبور کرده است	با backoff و jitter بعداً تلاش کنید.
`500`	خطای پیش‌بینی‌نشده سرور	درخواست را ثبت و بعداً با همان داده امتحان کنید.

نمونه خطای اعتبارسنجی:

{
  "message": "The attributes field is required.",
  "errors": {
    "attributes": ["The attributes field is required."]
  }
}

نمونه منبع پیدا نشده:

{
  "status": false,
  "message": "Not found."
}

برای 429 و خطاهای موقت 5xx از exponential backoff همراه jitter استفاده کنید.
خطاهای 401، 403، 404 و 422 را بدون اصلاح ورودی تکرار نکنید.
پیش از retry عملیات تغییردهنده، مشخص کنید پاسخ قبلی قبل یا بعد از ثبت تغییر قطع شده است.
دریافت مشتری و ساخت کد تخفیف برای ورودی یکسان رفتار تکرارپذیر دارند؛ retry کورکورانه برای همه عملیات توصیه نمی‌شود.

در این صفحه