فضاهای کاری (Workspaces)

فضاهای کاری (Workspace) محیطی ایزوله برای سازماندهی تیم‌ها، پروژه‌ها و منابع هستند. هر `API Key` به یک فضای کاری مشخص متصل است و تمام عملیات این بخش روی همان فضای کاری جاری (Current Workspace) انجام می‌شود.

هر کاربر می‌تواند حداکثر تعداد مشخصی فضای‌کاری داشته باشد (طبق تنظیمات سیستم).

نوع‌های مشترک (Common Types)

نام	توضیح
`Workspace`	شیء اصلی فضای کاری
`Credentials`	اطلاعات احراز هویت فضای کاری

فیلدهای Workspace:

فیلد	نوع	توضیح
`id`	`string`	شناسه یکتای فضای کاری (UUID)
`name`	`string`	نام فضای کاری
`subdomain`	`string`	ساب دامین اختصاصی فضای کاری

فیلدهای Credentials:

فیلد	نوع	توضیح
`secretKey`	`string`	کلید محرمانه فضای کاری
`sdkToken`	`string`	توکن SDK فضای کاری
`allowedDomains`	`string[]`	لیست دامین‌های مجاز
`enforceSecureIdentify`	`boolean`	وضعیت فعال بودن Secure Identify

مدیریت فضای کاری جاری (Current Workspace)

توجه: در این بخش دیگر نیازی به ارسال id یا ساب‌دامین در URL نیست؛ فضای کاری بر اساس x-api-key ارسالی تشخیص داده می‌شود.

دریافت فضای کاری جاری

GET https://api.fidegah.ir/v1/workspaces/current

curl -X GET https://api.fidegah.ir/v1/workspaces/current \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

خروجی درخواست:

فیلد	نوع	توضیح
`id`	`string`	شناسه یکتای فضای کاری (UUID)
`name`	`string`	نام فضای کاری
`subdomain`	`string`	ساب دامین اختصاصی فضای کاری

ویرایش فضای کاری جاری

PATCH https://api.fidegah.ir/v1/workspaces/current

curl -X PATCH https://api.fidegah.ir/v1/workspaces/current \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "نام جدید"
  }'

بدنه درخواست (Request Body - اختیاری):

پارامتر	نوع	توضیح
`name`	`string`	نام جدید فضای کاری
`subdomain`	`string`	ساب دامین جدید

خروجی درخواست: شیء Workspace پس از ویرایش.

دریافت اطلاعات احراز هویت فضای کاری

GET https://api.fidegah.ir/v1/workspaces/credentials

curl -X GET https://api.fidegah.ir/v1/workspaces/credentials \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

خروجی درخواست: شیء Credentials شامل secretKey، sdkToken، allowedDomains و enforceSecureIdentify.

ویرایش دامین‌های مجاز (Allowed Domains)

PATCH https://api.fidegah.ir/v1/workspaces/allowed-domains

curl -X PATCH https://api.fidegah.ir/v1/workspaces/allowed-domains \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "allowedDomains": ["example.com"]
  }'

بدنه درخواست (Request Body):

پارامتر	نوع	ضرورت	توضیح
`allowedDomains`	`string[]`	الزامی	لیست دامین‌های مجاز (حداکثر تعداد طبق تنظیمات سیستم)

خروجی درخواست:

فیلد	نوع	توضیح
`allowedDomains`	`string[]`	لیست دامین‌های مجاز به‌روزشده

فعال/غیرفعال کردن Secure Identify

PATCH https://api.fidegah.ir/v1/workspaces/secure-identify

curl -X PATCH https://api.fidegah.ir/v1/workspaces/secure-identify \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enforce": true
  }'

بدنه درخواست (Request Body):

پارامتر	نوع	ضرورت	توضیح
`enforce`	`boolean`	الزامی	فعال یا غیرفعال کردن Secure Identify

خروجی درخواست:

فیلد	نوع	توضیح
`enforceSecureIdentify`	`boolean`	وضعیت جدید Secure Identify

فضاهای کاری (Workspaces)

نوع‌های مشترک (Common Types)

مدیریت فضای کاری جاری (Current Workspace)

دریافت فضای کاری جاری

ویرایش فضای کاری جاری

دریافت اطلاعات احراز هویت فضای کاری

ویرایش دامین‌های مجاز (Allowed Domains)

فعال/غیرفعال کردن Secure Identify

On this page