مستندات استفاده از ذخیره ساز ابری هاست ایران
تنظیمات اتصال
برای اتصال به وب سرویس ذخیره ساز ابری هاست ایران،
1) ابتدا از پروفایل کاربری خود BASE_URL و TOKEN را بردارید.
2) سپس با در نظر گرفتن پارامترهای هدر و مستندات فنی ذیل به وبسرویس متصل شوید.
API های S3
بعد از ساخت و فعال سازی سرویس ذخیره ساز ابری هاست ایران شما می توانید با استفاده از وب سرویس های زیر مدیریت کاملی بر دسته بندی ها ، فایل ها و به اشتراک گذاری فایل داشته باشید.
ایجاد دسته بندی
با استفاده از درخواست "ایجاد دسته بندی" میتوانید دسته بندی ایجاد کنید.
POST
{
"token": "{TOKEN}"
}
{
title: "example-title",
is_public: 1,
parent_id: 5,
}
لیست دسته بندی ها
با استفاده از درخواست "لیست دسته بندی ها" میتوانید لیست دسته بندی ها را دریافت کنید.
GET
{
"token": "{TOKEN}"
}
پارامترهای ورودی :
| پارامتر | نوع | توضیح |
|---|---|---|
| perPage | int | تعداد آیتم های بازگشتی در درخواست |
| page | int | صفحهی مورد نظر از اطلاعات |
نمونه پاسخ :
{
"data": [
{
"hashid": "dmq5e",
"title": "تصویر",
"project": null,
"bucket": "dlir-img",
"is_public": 0,
"file_count": 0,
"file_size": 0,
"creator": {
"id": "lejme",
"fullname": "super admin superadmin",
"email": "cto@tookan.tech"
},
"users": null
};
{
"hashid": "bg9we",
"title": "جنرال",
"project": null,
"bucket": "dlir-general",
"is_public": 0,
"file_count": 0,
"file_size": 0,
"creator": {
"id": "lejme",
"fullname": "super admin superadmin",
"email": "cto@tookan.tech"
},
"users": null
}
],
"meta": {
"pagination": {
"total": 12,
"count": 12,
"per_page": 15,
"current_page": 1,
"total_pages": 1
},
"status": {
"status_code": 200,
"message": null
}
}
}
بارگزاری فایل
با استفاده از درخواست "بارگزاری فایل" میتوانید فایل بارگزاری کنید.
POST
{
"token": "{TOKEN}"
}
{
"files": "1627312162-ScreenShot2021-07-25at4.24.55AM.png",
"folder_id": "dmq5e",
parent_id: 5,
}
نمونه پاسخ :
{
"data": {
"hashid": "2expb",
"user": null,
"project": null,
"attempt": 1,
"data": {
"name": "1627312162-ScreenShot2021-07-25at4.24.55AM.png",
"size": "32.69 KB",
"folder_id": "dmq5e",
"type": "image/png",
"download": 0,
"secure": 0
},
"status": 2,
"status_title": "در صف ارسال",
"created_at": "04 مرداد 1400 ساعت 19:39"
},
"meta": {
"status": {
"status_code": 200,
"message": null
}
}
}
{
"message": "The given data was invalid.",
"errors": {
"folder_id": [
"دسته\u200cبندی مورد نظر یافت نشد"
]
}
}
بارگزاری فایل با URL
با استفاده از درخواست "بارگزاری فایل با URL" میتوانید با URL فایل بارگزاری کنید.
POST
{
"token": "{TOKEN}"
}
{
"urls[]": "https://digiato.com/wp-content/uploads/2021/04/google-io-2021-w1200.jpg",
"folder_id": "dmq5e11",
}
نمونه پاسخ :
{
"data": {
"hashid": "yb4kd",
"user": null,
"project": null,
"attempt": 1,
"data": {
"name": "1627312204-google-io-2021-w1200.jpg",
"size": "44.35 KB",
"folder_id": "dmq5e",
"type": "image/jpeg",
"download": 0,
"secure": 1
},
"status": 2,
"status_title": "در صف ارسال",
"created_at": "04 مرداد 1400 ساعت 19:40"
},
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1
},
"status": {
"status_code": 200,
"message": null
}
}
}
{
"message": "The given data was invalid.",
"errors": {
"folder_id": [
"دسته\u200cبندی مورد نظر یافت نشد"
]
}
}
جستجوی فایل
با استفاده از درخواست "جستجوی فایل" میتوانید فایل خود را جستجو کنید.
GET
{
"token": "{TOKEN}"
}
گرفتن وضعیت فایل
با استفاده از درخواست "گرفتن وضعیت فایل" میتوانید وضعیت فایل خود را دریافت کنید.
GET
{
"token": "{TOKEN}"
}
حذف فایل
با استفاده از درخواست "حذف فایل" میتوانید فایل خود را حذف کنید.
DELETE
{
"token": "{TOKEN}"
}
ساخت لینک امن
با استفاده از درخواست "ساخت لینک امن" میتوانید لینک امن بسازید.
POST
{
"token": "{TOKEN}"
}
{
"duration": 24,
}
دانلود وضعیت
با استفاده از درخواست "دانلود وضعیت" میتوانید وضعیت را دانلود کنید.
POST
{
"token": "{TOKEN}"
}
{
"id": 2,
"downloadable": 0,
}
استفاده از پکیجهای S3 Compatible
بعد از ساخت و فعال سازی سرویس ذخیره ساز ابری هاست ایران با استفاده از هر ابزار/ کتابخانه s3 compatible ، از قابلیت های پنل ذخیره ساز ابری هاست ایران استفاده کنید.
ساخت باکت
با استفاده از فراخوانی متد ساخت باکت ، میتوانید باکت بسازید.
وجود باکت
با استفاده از فراخوانی متد وجود باکت ، میتوانید از وجود باکت مطلع شوید.
بارگذاری / آپلود
با استفاده از فراخوانی متد بارگذاری / آپلود ، میتوانید آپلود کنید.
وجود شیء / فایل
با استفاده از فراخوانی متد وجود شیء / فایل ، میتوانید از وجود فایل مطلع شوید.
گرفتن ادرس فایل
با استفاده از فراخوانی متد گرفتن ادرس فایل ، میتوانید از آدرس فایل مطلع شوید.
حذف فایل
با استفاده از فراخوانی متد حذف فایل ، میتوانید فایل را حذف کنید.