مستندات Genesis API

هرچه برای یکپارچه‌سازی لازم است: احراز هویت، محدودیت‌ها، اندپوینت‌ها و اسکیمای پاسخ.

مستنداتخطاها

خطاها

خطاها با وضعیت HTTP متناظر و یک بدنه برمی‌گردند:

json
{
  "success": false,
  "error": {
    "code": "rate_limited",
    "message": "Requests per second limit exceeded."
  }
}
HTTPکدتوضیح
400bad_requestپارامترهای درخواست نامعتبر است — جزئیات در message
401invalid_keyکلید غایب، نامعتبر یا لغوشده، یا اشتراک API منقضی شده است
403plan_restrictedاندپوینت در پلن شما نیست
404not_foundاندپوینت یا منبع پیدا نشد
410goneاندپوینت بازنشسته شده است — جایگزین در message
429rate_limitedعبور از محدودیت — X-RateLimit و Retry-After را ببینید
429download_limitedحجم دانلود از حد مجاز گذشته است: 60 MB داده فشرده در هر 10 ثانیه برای هر کلید — Retry-After را ببینید
500internal_errorخطای داخلی، بعداً دوباره تلاش کنید
503snapshot_not_readyداده‌ها در حال بازسازی است یا منبع آن در حال راه‌اندازی مجدد است — چند ثانیه بعد دوباره تلاش کنید، Retry-After را ببینید

هر پاسخ هدر X-Request-Id دارد. هنگام تماس با پشتیبانی آن را همراه زمان درخواست به UTC، اندپوینت و وضعیت بفرستید — هرگز کلید خود را نفرستید.