فضاهای کاری (Workspaces)
فضاهای کاری (Workspace) محیطی ایزوله برای سازماندهی تیمها، پروژهها و منابع هستند. هر کاربر میتواند عضو چندین فضای کاری باشد و در هر فضای کاری، نقشی متفاوت (مانند عضو، مدیر یا ادمین) ایفا کند. این قابلیت به شما امکان میدهد دسترسیها و سطح اختیارات را برای هر کاربر به صورت مجزا مدیریت کنید.
نوعهای مشترک (Common Types)
| نام | توضیح |
|---|---|
Workspace | شیء اصلی فضای کاری |
فیلدهای Workspace:
| فیلد | نوع | توضیح |
|---|---|---|
id | number | شناسه یکتای فضای کاری |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
name | string | نام فضای کاری |
subdomain | string | ساب دامین اختصاصی فضای کاری |
role | 'owner' | 'admin' | 'contributor' | نقش کاربر در این فضای کاری |
is_banned | boolean | وضعیت مسدود بودن کاربر در این فضا |
author | User | اطلاعات کاربر سازنده |
فیلدهای User:
| فیلد | نوع | توضیح |
|---|---|---|
id | string | شناسه یکتای کاربر (UUID) |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
email | string | ایمیل |
full_name | string | نام کامل |
avatar_url | string | null | آدرس آواتار |
مدیریت فضاهای کاری (Workspaces)
دریافت لیست تمام فضاهای کاری
GET https://api.fidegah.ir/v1/workspaces
curl -X GET https://api.fidegah.ir/v1/workspaces \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای Query (Query Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
search | string | جستجو بر اساس نام |
sortBy | string | فیلد مرتبسازی (پیشفرض created_at) |
sortOrder | 'asc' | 'desc' | جهت مرتبسازی (پیشفرض desc) |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | []Workspace | آرایه شامل لیست فضاهای کاری |
دریافت فضای کاری با شناسه
GET https://api.fidegah.ir/v1/workspaces/:id
curl -X GET https://api.fidegah.ir/v1/workspaces/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | number | شناسه فضای کاری مورد نظر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Workspace | شیء فضای کاری درخواستی |
ایجاد فضای کاری جدید
POST https://api.fidegah.ir/v1/workspaces
curl -X POST https://api.fidegah.ir/v1/workspaces \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "فضای کاری من",
"subdomain": "my-workspace"
}'بدنه درخواست (Request Body):
| پارامتر | نوع | ضرورت | توضیح |
|---|---|---|---|
name | string | الزامی | نام فضای کاری (حداقل ۳، حداکثر ۲۰ کاراکتر) |
subdomain | string | الزامی | ساب دامین اختصاصی (حروف کوچک، اعداد و خط تیره) |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Workspace | شیء فضای کاری ایجاد شده |
ویرایش فضای کاری
PATCH https://api.fidegah.ir/v1/workspaces/:id
curl -X PATCH https://api.fidegah.ir/v1/workspaces/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "نام جدید"
}'پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | number | شناسه فضای کاری مورد نظر |
بدنه درخواست (Request Body - همگی اختیاری):
| پارامتر | نوع | توضیح |
|---|---|---|
name | string | نام جدید فضای کاری |
subdomain | string | ساب دامین جدید |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Workspace | شیء فضای کاری پس از ویرایش |
حذف فضای کاری
DELETE https://api.fidegah.ir/v1/workspaces/:id
curl -X DELETE https://api.fidegah.ir/v1/workspaces/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | number | شناسه فضای کاری مورد نظر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
message | string | پیام نتیجه حذف |
مدیریت کاربران در فضای کاری
ارسال سابدامین در این آدرس الزامی است. اطلاعات بیشتر
دریافت لیست کاربران فضای کاری
GET https://{subdomain}.api.fidegah.ir/v1/workspaces/:id/users
curl -X GET https://{subdomain}.api.fidegah.ir/v1/workspaces/{id}/users \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | number | شناسه فضای کاری مورد نظر |
پارامترهای Query (Query Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
search | string | جستجو بر اساس نام کامل کاربر |
sortBy | string | فیلد مرتبسازی (پیشفرض created_at) |
sortOrder | 'asc' | 'desc' | جهت مرتبسازی (پیشفرض desc) |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | []WorkspaceUsers | آرایه شامل لیست کاربران فضای کاری |
pagination | Pagination | اطلاعات صفحهبندی (مشاهده جزئیات) |
فیلدهای WorkspaceUsers:
| فیلد | نوع | توضیح |
|---|---|---|
id | string | شناسه یکتای کاربر (UUID) |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
workspace_id | number | شناسه یکتای محیط کاری |
role | 'owner' | 'admin' | 'contributor' | نقش کاربر در این فضای کاری |
is_banned | boolean | وضعیت مسدود بودن کاربر در این فضا |
banned_at | string | null | تاریخ مسدود شدن |
user | User | اطلاعات کاربر |