صفحهبندی (Pagination)
راهنمای نحوه مدیریت و دریافت دادههای حجیم با استفاده از صفحهبندی.
صفحهبندی (Pagination)
درخواستهایی که خروجی بزرگی دارند (مانند لیست بازخوردها یا لیست کاربران)، برای بهینهسازی سرعت و کاهش حجم دیتای انتقالی، به صورت اجباری صفحهبندی میشوند. شما میتوانید با استفاده از پارامترهای مشخص، تعیین کنید که چه بخش از دادهها را نیاز دارید.
پارامترهای ورودی (Query Parameters)
برای کنترل صفحهبندی، میتوانید پارامترهای زیر را به انتهای آدرس درخواست (Query String) اضافه کنید:
| پارامتر | نوع | پیشفرض | حداکثر | توضیح |
|---|---|---|---|---|
page | number | 1 | - | شماره صفحه مورد نظر |
limit | number | 10 | 100 | تعداد آیتم در هر صفحه |
offset | number | 0 | - | تعداد آیتمهای نادیده گرفته شده. معادل limit × (page - 1) است |
در صورت ارسال همزمان page و offset، اولویت با offset خواهد بود.
ساختار پاسخ صفحهبندی (Pagination Object)
آدرسهایی که از صفحهبندی پشتیبانی میکنند، دادههای خود را همراه با یک شیء متادیتا ارسال میکنند تا وضعیت صفحات را به شما نشان دهد. ساختار این شیء به شرح زیر است:
| فیلد | نوع | توضیح |
|---|---|---|
page | number | شماره صفحه جاری |
limit | number | تعداد آیتم در هر صفحه |
total | number | تعداد کل آیتمها |
totalPages | number | تعداد کل صفحات |
hasNext | boolean | وجود صفحه بعدی (true/false) |
hasPrev | boolean | وجود صفحه قبلی (true/false) |
احراز هویت (Authentication)
راهنمای نحوه دریافت کلید دسترسی (API Key) و احراز هویت درخواستها.
فضاهای کاری (Workspaces)
فضاهای کاری (Workspace) محیطی ایزوله برای سازماندهی تیمها، پروژهها و منابع هستند. هر کاربر میتواند عضو چندین فضای کاری باشد و در هر فضای کاری، نقشی متفاوت (مانند عضو، مدیر یا ادمین) ایفا کند. این قابلیت به شما امکان میدهد دسترسیها و سطح اختیارات را برای هر کاربر به صورت مجزا مدیریت کنید.