پاداسپیس- مدیریت کاربران

خدمت‌دهنده

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

دانلود Postman Collection فراخوانی آزمایشی _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) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.

گروه کاربران

ایجاد گروه کاربران

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

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

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

ssoid*

لیست ssoid افراد مورد نظر برای اضافه شدن به گروه

برای این درخواست باید درخواست دهنده نقش USER_GROUP_MANAGER_ROLE داشته باشد.

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

json

حذف گروه کاربران

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

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

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

userGroupHash*

هش گروه کاربران مورد نظر

برای این درخواست باید درخواست دهنده نقش USER_GROUP_MANAGER_ROLE داشته باشد.

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

json

دریافت اطلاعات یک گروه کاربری

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

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

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

userGroupHash*

هش گروه کاربران مورد نظر

fullEntity

مشاهده جزئیات کامل فایل های گروه

پیش فرض = false

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

json

اشتراک فایل با گروه کاربران

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

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

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

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

برای این درخواست باید درخواست دهنده نقش USER_GROUP_MANAGER_ROLE داشته باشد.

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

json

حذف فایل مشترک شده با گروه کاربران

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

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

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

userGroupHash*	هش گروه کاربران مورد نظر
fileHash*	هش فایل جهت حذف اشتراک گذاری (الزامی)

برای این درخواست باید درخواست دهنده نقش USER_GROUP_MANAGER_ROLE داشته باشد.

اضافه کردن کاربر به گروه کاربارن

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

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

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

userGroupHash*	هش گروه کاربران مورد نظر
ssoId*	لیست ssoid افراد مورد نظر برای اضافه شدن به گروه (الزامی)

برای این درخواست باید درخواست دهنده نقش USER_GROUP_MANAGER_ROLE داشته باشد.

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

json

حذف کاربر از گروه کاربران

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

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

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

userGroupHash*

هش گروه کاربران مورد نظر (الزامی)

ssoId*

لیست ssoid افراد مورد نظر برای حذف شدن از گروه(الزامی)

removeGroupIfEmpty

حذف گروه درصورت خالی شدن

پیش فرض = false

برای این درخواست باید درخواست دهنده نقش USER_GROUP_MANAGER_ROLE داشته باشد.

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

java

آپلود فایل در گروه کاربران

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

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

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

userGroupHash*	هش گروه کاربران مورد نظر
file*	فایل برای آپلود (الزامی)
userMetadata	اطلاعات همراه فایل
description	توضیحات فایل
tags	آرایه تگهای فایل
uploadKey	کلید بارگذاری

واضح است که کاربر آپلود کننده باید در گروه کاربران حضور داشته باشد.
پس از این درخواست برای اینکه کاربر آپلود کننده یا کاربران دیگر بتوانند به فایل دسترسی داشته باشند باید فایل توسط ایجاد کننده ی گروه کاربری با گروه کاربران اشتراک گذاری شود.

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

json

آپلود تصویر در گروه کاربران

از این متد برای آپلود تصویر در یک گروه کاربران استفاده میشود.

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

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

userGroupHash*	هش گروه کاربران مورد نظر (الزامی)
file*	فایل تصویر برای آپلود (الزامی)
path	مسیر آپلود فایل
folderHash	کد هش فولدری که فایل می خواهد درونش آپلود شود.به صورت پیش فرض در root آپلود می شود.
x	شروع عرض برش
y	شروع ارتفاع برش
width	مقدار عرض برش
height	مقدار ارتفاع برش
userMetadata	اطلاعات همراه فایل
Description String	توضیحات فایل
tags	آرایه تگهای فایل
uploadKey	کلید بارگذاری

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

json

فعالیت‌ها

دریافت فعالیت‌های اخیر

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

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

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

start	ایندکس شروع اولین آیتم برای بازگردانی
size	تعداد آیتم های بازگردانی شده
desc	مرتب سازی نزولی.

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

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	درخواست دسترسی قبلا ارسال شده