توسعه‌دهندگان
ابردرایو همه‌ی کارهایی را که در برنامه‌ی وب می‌بینید از راه یک API انجام می‌دهد: مرور و جست‌وجوی پوشه‌ها، بارگذاری و دانلود، اشتراک‌گذاری، فشرده‌سازی و رمزگذاری، طبقه‌بندی و فیلدهای سفارشی، گردش‌کارها و اتصال‌های بیرونی. با همین API می‌توانید ابردرایو را از Postman یا از سرویس خودتان صدا بزنید و آن را به سامانه‌های دیگر وصل کنید.
این بخش برای توسعه‌دهندگانی است که مدیر سامانه‌ی یک استقرار ابردرایو به آن‌ها اجازه داده با API کار کنند. هر استقرار سرور خودش را دارد؛ نشانی‌ها را از مدیر سامانه‌ی همان استقرار بگیرید.
نسخه و موج اول
این مستندات API نسخه‌ی ۱، موج اول را توضیح می‌دهد. همه‌ی مسیرهای این نسخه با /api/v1 شروع می‌شوند. مرجع از کد ابردرایو نسخه‌ی 2026.10.9 ساخته شده است.
موج اول عمداً محدود است: فقط درخواست‌هایی را می‌آورد که برنامه‌ی وب ابردرایو از راه دروازه‌ی API هر گره استفاده می‌کند، به‌علاوه‌ی درخواست یافتن گره. درخواستی که در این مرجع نیامده، بخشی از API عمومی نیست؛ ممکن است بدون اطلاع قبلی تغییر کند یا حذف شود و نباید به آن تکیه کنید.
فرض‌های موج اول
این فرض‌ها را پیش از شروع بخوانید. در موج‌های بعدی بعضی از آن‌ها برداشته می‌شوند.
- ورود فقط با صفحه‌ی ورود ابردرایو. توکن دسترسی فقط وقتی صادر می‌شود که کاربر در صفحه‌ی ورود ابردرایو وارد شود. ورود بدون دخالت کاربر (کلید API یا ورود سرویس به سرویس) هنوز وجود ندارد. جزئیات در احراز هویت.
- هر درخواست از طرف یک کاربر است. توکن به نام کاربری است که وارد شده و هر درخواست فقط به فضای همان کاربر دسترسی دارد. نقش‌های ناظر و مدیر سامانه همان نقش‌های برنامه‌ی وب هستند.
- مدیر سامانه باید Postman را مجاز کند. نشانی بازگشت Postman باید یک بار در تنظیمات سرور ورود ثبت شود و پس از هر ارتقای ابردرایو دوباره ثبت شود.
- هر کاربر یک گره دارد. درخواست‌ها به دروازه‌ی API گره‌ی کاربر فرستاده می‌شوند. نشانی آن را با درخواست یافتن گره بگیرید.
- رفتار فعلی مستند شده است. هرجا رفتار سرور هنوز با انتظار یکی نیست (مثلاً کدی که باید
401باشد و500است)، همان رفتار فعلی نوشته شده است.
آنچه در موج اول نیست
- ورود بدون کاربر (کلید API، حساب سرویس، ورود سرویس به سرویس).
- اعلان‌ها و پیام‌های زنده.
- بارگذاری تکه‌تکه و ازسرگیری‌پذیر (tus). در این موج فایل‌ها را با بارگذاری فایل در یک درخواست بفرستید.
- ساختن رابط کاربری جداگانه روی دامنه‌ی دیگر. برای این کار مدیر سامانه باید دامنه‌ی شما را در تنظیمات CORS و نشانی‌های بازگشت ثبت کند؛ این موضوع در این موج توضیح داده نشده است.
ترتیب پیشنهادی
- احراز هویت: توکن بگیرید.
- یافتن گره: نشانی دروازه‌ی API را پیدا کنید.
- قراردادهای مشترک: سرآیندها، صفحه‌بندی، خطاها و کارهای ناهمگام.
- مرجع API: همه‌ی درخواست‌ها.