پاداسپیس- نشانه گذاری فایل-پوشه

خدمت‌دهنده

بازارچه پادیوم

فراخوانی آزمایشی _BETA اطلاعات مجموعه سرویس

مقدمه

سرویس اسپیس ، امکان استفاده‌ از بستر ابری پلتفرم پاد را برای مشتریان مهیا می‌سازد. این سرویس به صورت REST پیاده سازی شده‌است.

اسپیس یک مکان ذخیره‌‌سازی برای فایل‌های مورد‌نیاز کسب‌و‌کار است و در این‌بستر امکان آپلود، دانلود و مدیریت فایل‌های شخصی وجود‌ دارد.

با استفاده از درخواست‌های HTTP می‌توان بر‌روی منابع کنش انجام‌داد.

پیش از شروع

URL فراخوانی سرویسها:

Production Server: https://api.pod.ir/srv/sc/nzh/doServiceCall

Sandbox Server:https://sandbox.pod.ir/srv/sc/nzh/doServiceCall

تمامی درخواستها با متد POST ارسال میشوند.
فیلدهای زیر درHeader تمامی درخواستها ثابت است:

پارامتر	توضیحات
_token_	توکن کسبوکاری دریافتی از پنل
_token_issuer_	مقدار ثابت "1"

فیلدهای زیر در بدنه‌ی تمامی درخواست‌ها ثابت است (با فرمت x-www-form-urlencoded):

پارامتر	توضیحات
scProductId	شناسه‌ی سرویس مدنظر
scApiKey	راهنمای دریافت این پارامتر در این لینک موجود است.

علاوه بر موارد بالا که ثابت هستند، اگر سرویس نیاز به پارامتر دیگری داشته باشد در داکیومنت مربوطه ذکر شده است.
خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.

نکته:پس از درخواست سرویس به پادیوم، همکاران ما درخواستهای ارسالی را بررسی می‌کنند. در صورت عدم دریافت تایید کرد بر روی درخواست ارسالی ظرف یک روز کاری،به همکاران ما از طریق شماره تلفن (021-89518989) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.

نشانه گذاری

با استفاده از این‌ متد می‌توان لیستی از فایل‌ها و فولدر‌ها را به‌ دسترسی سریع افزود.

شماره سرویس : 48138

پارامترهای ورودی:

fileHashes	لیستی از هش فایل‌ها برای نشانه‌گذاری
folderHashes	لیستی از هش فولدر‌ها برای نشانه‌گذاری

پاسخ نمونه در صورت موفقیت‌آمیز بودن:

json

در فیلد result پاسخ درخواست، تعداد فایل (ها) و فولدر(ها)یی که به درستی نشانه‌گذاری شده اند برگردانده می ‌شود.در صورت وارد کردن هش اشتباه result عدد صفر را بر می‌گرداند.

لیست بوک مارک‌ها

با استفاده از این‌ متد می توان لیست فایل ‌ها و فولدر‌های نشانه‌گذاری شده توسط کاربر دریافت کرد.

شماره سرویس : 48139

پارامترهای ورودی:

offset	شماره اولین آیتم
size	تعداد آیتم بازگشتی
order	ترتيب نمايش (name, created, kind)
desc	ترتيب نمايش صعودي(false) پیشفرض / نزولي (true)

پاسخ نمونه در صورت موفقیت‌آمیز بودن:

حذف نشانه

با استفاده از این‌ متد می‌توان نشانه‌گذاری از لیستی از فایل‌ها و فولدر‌ها را حذف نمود.

شماره سرویس : 48140

پارامترهای ورودی:

fileHashes	لیستی از هش فایل‌ها برای حذف نشانه‌گذاری
folderHashes	لیستی از هش فولدر‌ها برای حذف نشانه‌گذاری

پاسخ نمونه در صورت موفقیت‌آمیز بودن:

json

در فیلد result پاسخ درخواست، تعداد فایل (ها) و فولدر(ها)یی که حذف نشانه‌گذاری شده اند برگردانده می ‌شود.در صورت وارد کردن هش اشتباه result عدد صفر را بر می‌گرداند.

لیست فایل‌های Bookmark

شماره سرویس : 1320911

پارامترهای ورودی:

نام پارامتر	نوع پارامتر	اجباری	توضیحات
start	String	*	مقدار شروع صفحه را مشخص می سازد. نفطه آغار صفر می باشد
size	String	*	مقدار رکوردهای برگشتی را مشخص می سازد
desc	bool		نحوه مرتب سازی خروجی را مشخص می سازد. به صورت پیش فرض مقدار false دارد.
order	String		مرتب سازی بر مبنای NAME یا CREATED می باشد. به صورت پیش فرض Name می باشد

خروجی سرویس

json

در بخش لیست فایل های bookmark شده به همراه جزئیات در اختیار کاربر قرار می گیرد.

Bookmark کردن یک فایل

شماره سرویس : 1335744

پارامترهای ورودی:

نام پارامتر

نوع پارامتر

اجباری

توضیحات

hash

String

مقدار Hash فایل را مشخص می شود

خروجی سرویس

json

حذف یک فایل از لیست Bookmark ها

شماره سرویس : 1335745

پارامترهای ورودی:

نام پارامتر	نوع پارامتر	اجباری	توضیحات
hash	String	*	مقدار Hash فایل را مشخص می شود

خروجی سرویس

json

ساخت پست برای فایل

از این‌ متد برای ساخت پست برای فایل استفاده می‌شود.به‌عنوان ورودي fileHash، canLike و canComment را دريافت مي‌کند. در نتیجه اجرای این دستور، برای فایل مورد نظر یک پست ساخته می‌شود که می‌توان با سرویس‌های دیگر پاد کار‌هایی مثل لایک، نظر دادن و... را برای آن انجام داد.

شماره سرویس : 2961759

پارامترهای ورودی:

fileHash*	کد هش فایل مورد نظر
canComment *	امکان کامنت گذاری برای کاربر
canLike *	امکان لایک برای کاربر

پاسخ نمونه درصورت موفقیت‌آمیز بودن:

json

مدیریت پوشه

ایجاد پوشه

از این متد برای ایجاد یک پوشه جدید استفاده میشود.

شماره سرویس : 47566

پارامترهای ورودی:

name*	نام پوشه
parentHash	کد هش پوشه والد(در صورت خالی‌بودن، در فولدر root ساخته می‌شود)
force	در صورت تکراری بودن نام، از نام یکتا استفاده شود

پاسخ نمونه در صورت موفقیت‌آمیز بودن:

json

دریافت فرزندان (محتویات) پوشه

شماره سرویس : 2961760

پارامترهای ورودی:

hash*	هش پوشه مورد نظر. (الزامی) برای پوشه اصلی می‌توانید از ROOT استفاده کنید
start	شماره اولین آیتم پیشفرض = 0
size	تعداد آیتم بازگشتی پیشفرض = 25
order	ترتيب نمايش پیشفرض = NAME (NAME,CREATED,UPDATED,SIZE,TYPE)
desc	ترتیب صعودی/نزولی پیشفرض =false
breadcrumb	نمایش راهنمای ناوبری پیشفرض =false
password	کلمه عبور فولدر
filterAttribute	فیلتر کردن خروجی بر اساس ویژگی مورد نظر.
filterValue	مقدار مورد نظر برای فیلتر داده شده درحالتی که فیلتر روی TYPE باشد مقدار مورد نظر برای فیلتر داده شده میتواند به صورت زیر باشد: برای فولدر vnd.podspace.folder یا text , image, video , audio , .. یا حتی میتواند مقدار دقیقتری برای مثال jpeg قرار داده شود.

پاسخ نمونه در صورت موفقیت‌آمیز بودن:

json

دریافت ساختار درختی پوشه

از این متد برای دریافت ساختار درختی یک پوشه استفاده میشود.

شماره سرویس : 2961761

پارامتر ورودی:

hash*

هش پوشه مورد نظر. (الزامی)

پاسخ نمونه در صورت موفقیت‌آمیز بودن:

json

ساخت چند پوشه با یک درخواست

از این متد برای ایجاد چند پوشه با یک درخواست استفاده میشود.

شماره سرویس : 2961762

پارامترهای ورودی:

directories*

مسیر مورد نظر که با / آغاز می‌شود و تمام می‌شود. (الزامی)

(تمام فولدرهای مسیر داده شده در صورت موجود نبودن ساخته می‌شوند.)

hash

هش پوشه والد

درصورت وارد نکردن در root‌ایجاد میشود.

پاسخ نمونه در صورت موفقیت‌آمیز بودن:

json

کدهای خطای سرویس

400	INVALID_REQUEST	درخواست نامعتبر
400	INVALID_HASH_TYPE	هش نادرست
400	INVALID_DATA	داده ورودی نامعتبر
400	CANNOT_BOOKMARK_DELETED_ENTITY	نشان گذاری فایل حذف شده
400	INVALID_SSO_TYPE	مرکز sso نامعتبر
400	INVALID_REDIRECT_URI	آدرس بازگشت نامعتبر
400	INVALID_HASH	هش نامعتبر
400	INVALID_NAME	نام نامعتبر
400	INVALID_AUTHENTICATION_INFORMATION	اطلاعات کاربری نامعتبر
400	INVALID_SORT_PROPERTY	پارامتر مرتب سازی نامعتبر
400	LAST_FILE_VERSION	عدم امکان بازگشت به نسخه آخر

400	INVALID_EXPIRATION_DATE	تاریخ انقضای اشتباه
400	INVALID_DATE	تاریخ نامعتبر
400	INVALID_DATE_FORMAT	فرمت نامعتبر تاریخ
400	INVALID_DATE_FORMAT_YYMMDD	فرمت نامعتبر تاریخ
400	INVALID_DATE_INTERVAL	بازه تاریخی اشتباه
400	INVALID_PHONE_NUMBER	شماره موبایل اشتباه
400	INVALID_NATIONAL_CODE	فرمت اشتباه کد ملی
400	INVALID_PAGINATION_PARAM	پارامتر های صفحه بندی نامعتبر
400	INVALID_PAGINATION_SIZE	پارامتر size غیرمجاز
400	INVALID_FOLDER_DEPTH	عمق پوشه غیر مجاز
400	INVALID_FILTER_PARAMETER	پارامتر فیلتر نامعتبر
400	INVALID_FILE_SIZE	تعداد فایلهای بیش از حد مجاز
400	INVALID_FOLDERTREE_SIZE	اندازه بیش از حد درخت پوشه
400	INVALID_FOLDER_FORMAT	فرمت مسیر (directory) نادرست

کپی یا انتقال غیرمجاز

400	MOVE_INSIDE_ITS_OWN	انتقال پوشه داخل خودش
400	MOVE_INSIDE_ITS_SUBFOLDER	انتقال پوشه داخل پوشه های فرزند خودش
400	COPY_INSIDE_ITS_OWN	کپی پوشه درون خودش
400	COPY_INSIDE_ITS_SUBFOLDER	کپی پوشه داخل پوشه های فرزند خودش

درخواست‌های نامعتبر

400	DUPLICATE_NAME	نام تکراری در پوشه
400	ONLY_TRASHED_ENTITIES_CAN_BE_WIPED	عدم امکان حذف دائمی فایل های trash نشده
400	FILE_NOT_SENT	فایل ارسال نشده
400	ENTITY_BEEN_SHARED	اشتراک گذلری تکراری
400	INVALID_PLAN_ID	شناسه طرح نادرست
400	INVALID_PLAN_DATE	خرید طرح با زمان کمتر از طرح فعلی
400	INVALID_BILL_NUMBER	فاکتور کنسل شده
400	SSO_INVALID_REQUEST	کد تایید نامعتبر

مربوط به فضای ذخیره سازی

402	INSUFFICIENT_SPACE	عدم وجود فضای کافی
402	PAYMENT_REQUIRED	نیاز به خرید طرح

دسترسی های غیرمجاز

403	WRONG_PASSWORD	رمز نادرست
403	FORBIDDEN	دسترسی غیرمجاز
403	SHARE_FORBIDDEN	عدم دسترسی برای اشتراک گذلری

پیدا نشدن منابع

404	NOT_FOUND	عدم وجود درخواست
404	ENTITY_NOT_FOUND	عدم وجود فایل یا پوشه
404	FILE_NOT_FOUND	عدم وجود فایل
404	FOLDER_NOT_FOUND	عدم وجود پوشه
404	SHARE_NOT_FOUND	عدم وجود اشتراک گذاری
404	USERGROUP_NOT_FOUND	عدم وجود گروه کاربری
404	USER_NOT_FOUND	عدم وجود کاربر
404	DESTINATION_FOLDER_NOT_FOUND	عدم وجود پوشه مقصد
404	THUMBNAIL_NOT_FOUND	عدم وجود تصویر شاخص
404	PLAN_NOT_FOUND	عدم وجود طرح
404	BILL_NUMBER_NOT_FOUND	عدم وجود شناسه کسب و کاری فاکتور
404	AVATAR_NOT_FOUND	عدم وجود آواتار
404	METADATA_KEY_NOT_FOUND	عدم وجود کلید داده شده
404	METADATA_KEYS_NOT_FOUND	عدم وجود کلیدهای داده شده
404	NOT_FOUND_PLATFORM	عدم وجود پلتفرم
404	STREAMER_NOT_FOUND	عدم وجود استریمر فعال
404	BUSINESS_NOT_FOUND	عدم وجود کسب و کار
404	UPLOAD_KEY_NOT_FOUND	عدم وجود کلید آپلود
404	ENTITY_IS_REMOVED	فایل یا پوشه حذف شده

غیرقابل پذیرش

406	NAME_NOT_CHANGED	عدم تغیرنام
406	NOT_ACCEPTABLE	عدم قبول محتوای ارسالی
406	NOT_STREAMABLE	عدم امکانم استریم کردن فایل

خطاهای دیگر

401	UNAUTHORIZED	عدم دسترسی
401	INVALID_AUTHORIZATION_TYPE	نوع احراز هویت نامعتبر
401	USER_GROUP_OWNER_UNAUTHORIZED	عدم دسترسی به گروه کاربری
401	FILE_OWNER_UNAUTHORIZED	عدم دسترسی به فایل
401	UPLOAD_KEY_HAS_BEEN_DELETED	کلید حذف شده
401	UPLOAD_KEY_DOES_NOT_EXIST	عدم وجود کلید
401	UPLOAD_KEY_IS_NOT_VALID	کلید نامعتبر
403	BUSINESS_IS_NOT_CONFIRMED	کسب و کار تایید نشده
403	NON_BUSINESSES_CANT_REQUEST_ACCESS	عدم امکان درخواست برای کاربران غیرکسبو کار
403	Bulk_API_INVALID_BATCH_API	عدم پشتیبانی url‌ از حالت batch
413	Bulk_API_PAYLOAD_TOO_LARGE	تعداد عملیات بیش از سقف مجاز
409	FILE_ALREADY_EXISTS	فایل قبلا ارسال شده
409	TEAM_ALREADY_EXIST	تیم قبلا ایجاد شده
409	BUSINESS_ACCESS_ALREADY_REQUESTED	درخواست دسترسی قبلا ارسال شده