RemoteGymp · API v1

محدودیت‌ها و خطاها

هر صفحه را بخوانید، محدودیت‌های سرعت را رعایت کنید و با خیال راحت از خطاها بازیابی کنید.

  1. محدودیت‌های سرعت

    محدودیت‌ها قابل تنظیم هستند. GET /v1/operations/capabilities گزارش‌های requestsPerMinute و authenticationRequestsPerMinutePerIp را ارائه می‌دهد. پس از دریافت خطای ۴۲۹، به Retry-After احترام بگذارید و در صورت ادامه‌ی کاهش سرعت، بیشتر صبر کنید. خواندن دسته‌ای تا ۱۰۰ شناسه را می‌پذیرد. نقاط انتهایی منفرد ممکن است محدودیت‌های صفحه یا بار کمتری داشته باشند.

  2. هر صفحه را بخوانید

    از قانون ادامه برای نقطه پایانی که فراخوانی کرده‌اید استفاده کنید و فیلترهای یکسان را حفظ کنید. لیست‌ها می‌توانند در حین خواندن شما تغییر کنند؛ وقتی به یک کپی ثابت نیاز دارید، از اسنپ‌شات‌ها استفاده کنید.

    صفحه‌بندیادامه باتوقف زمانی
    مکان‌نماnext را به عنوان after وارد کنید.بعدی null است.
    افست با nextOffsetnextOffset را به عنوان offset وارد کنید.nextOffset برابر با null است.
    جابجایی با hasMoreجابجایی را به تعداد اقلام برگشتی افزایش دهید.hasMore برابر با false است.
    نرم‌افزارمقدار عددی next را به عنوان after ارسال کنید؛ در صورت تغییر updatedAtUtc، مجدداً راه‌اندازی کنید.بعدی null است.
    فید رویدادnext را به عنوان after وارد کنید.hasMore برابر با false است.
  3. مدیریت خطاها

    کد خطا و همچنین وضعیت HTTP را بخوانید. اگر پاسخ شامل requestId است، هنگام تماس با پشتیبانی آن را ذکر کنید.

    وضعیت HTTPچه باید کرد
    400درخواست را برطرف کنید.
    401اعتبارنامه‌ها را بررسی کنید یا یک توکن دسترسی جدید دریافت کنید.
    403دامنه، مجوزها و فعال بودن دسترسی را بررسی کنید.
    404ممکن است منبع از دست رفته یا خارج از محدوده شما باشد.
    409قبل از تصمیم‌گیری، کد خطا و وضعیت فعلی را بخوانید.
    410عکس فوری یا مکان‌نمای رویداد منقضی شده است. یک خط پایه جدید شروع کنید.
  4. اگر زمان نوشتن تمام شد

    زمان پایان یا 503 ثابت نمی‌کند که اقدام ناموفق بوده است. برای نوشتن‌هایی که رسیدهای عملیات را برمی‌گردانند، قبل از تلاش مجدد، GET /v1/operations/by-key?idempotencyKey={key} را جستجو کنید. برای ایجاد نگهداری، از Idempotency-Key و بدنه اصلی دوباره استفاده کنید.

مرجع API →

بازنگری محتوا 3f225a253 · OpenAPI SHA-256: b12c42306a89