رفتن به محتوا

مرجع API

تیم‌ها

اعضای سازمان را برای مدیریت ساده‌تر دسترسی‌ها گروه‌بندی کنید. عضویت در تیم، جای grant پروژه یا مجوزهای سازمان را نمی‌گیرد.

روند کار

  1. 01ساخت تیم
  2. 02افزودن عضو به تیم
  3. 03دریافت اطلاعات تیم

روی هر عملیات بزنید تا همهٔ ورودی‌ها، request، response و کدهای وضعیت آن را ببینید.

ساخت تیم

POST/api/v1/tenancy/teams
آدرس پایهٔ APIhttps://api.mahvashai.ir
احراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش
نوع محتواapplication/json

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

ناممحل ارسالنوعالزامیپشتیبانیتوضیحات
X-Request-IDHeaderstringاختیاریمخصوص مهوششناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
X-Mahvash-ProjectHeaderstringاختیاریمخصوص مهوشslug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.
nameBodystringالزامیمخصوص مهوشنام نمایشی، بین ۱ تا ۱۲۰ نویسه.
slugBodystringاختیاریمخصوص مهوشدر سازمان یکتاست. اگر نفرستید از روی نام ساخته می‌شود؛ اگر نام حرف مناسبی نداشته باشد، slug تصادفی با پیشوند team- می‌گیرد و اگر تکراری باشد، پسوند تصادفی به آن اضافه می‌شود.

Request

curl -X POST 'https://api.mahvashai.ir/api/v1/tenancy/teams' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Marketing"
}'

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTPتوضیحات
201منبع ساخته شد.
400request نامعتبر است.
401اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403دسترسی لازم را ندارید.
404منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429از سقف مجاز عبور کرده‌اید.
500خطای داخلی سرور.

افزودن عضو به تیم

POST/api/v1/tenancy/teams/{team_id}/members
آدرس پایهٔ APIhttps://api.mahvashai.ir
احراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

ناممحل ارسالنوعالزامیپشتیبانیتوضیحات
team_idمسیر (path)stringالزامیمخصوص مهوششناسهٔ تیم.
X-Request-IDHeaderstringاختیاریمخصوص مهوششناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
X-Mahvash-ProjectHeaderstringاختیاریمخصوص مهوشslug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.

Request

curl -X POST 'https://api.mahvashai.ir/api/v1/tenancy/teams/<team_id>/members' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT"

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTPتوضیحات
201منبع ساخته شد.
400request نامعتبر است.
401اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403دسترسی لازم را ندارید.
404منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429از سقف مجاز عبور کرده‌اید.
500خطای داخلی سرور.

دریافت اطلاعات تیم

GET/api/v1/tenancy/teams/{team_id}
آدرس پایهٔ APIhttps://api.mahvashai.ir
احراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

ناممحل ارسالنوعالزامیپشتیبانیتوضیحات
team_idمسیر (path)stringالزامیمخصوص مهوششناسهٔ تیم.
X-Request-IDHeaderstringاختیاریمخصوص مهوششناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
X-Mahvash-ProjectHeaderstringاختیاریمخصوص مهوشslug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.

Request

curl -X GET 'https://api.mahvashai.ir/api/v1/tenancy/teams/<team_id>' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT"

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTPتوضیحات
200request با موفقیت انجام شد.
401اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403دسترسی لازم را ندارید.
404منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429از سقف مجاز عبور کرده‌اید.
500خطای داخلی سرور.

ویرایش نام یا توضیح تیم

PATCH/api/v1/tenancy/teams/{team_id}
آدرس پایهٔ APIhttps://api.mahvashai.ir
احراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش
نوع محتواapplication/json

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

ناممحل ارسالنوعالزامیپشتیبانیتوضیحات
team_idمسیر (path)stringالزامیمخصوص مهوششناسهٔ تیم.
X-Request-IDHeaderstringاختیاریمخصوص مهوششناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
X-Mahvash-ProjectHeaderstringاختیاریمخصوص مهوشslug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.
descriptionBodystringاختیاریمخصوص مهوشمتن آزاد، حداکثر ۵۰۰ نویسه.
nameBodystringاختیاریمخصوص مهوشنام نمایشی، بین ۱ تا ۱۲۰ نویسه.

Request

curl -X PATCH 'https://api.mahvashai.ir/api/v1/tenancy/teams/<team_id>' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Campaign work"
}'

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTPتوضیحات
200request با موفقیت انجام شد.
400request نامعتبر است.
401اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403دسترسی لازم را ندارید.
404منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429از سقف مجاز عبور کرده‌اید.
500خطای داخلی سرور.

بایگانی تیم

DELETE/api/v1/tenancy/teams/{team_id}
آدرس پایهٔ APIhttps://api.mahvashai.ir
احراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

ناممحل ارسالنوعالزامیپشتیبانیتوضیحات
team_idمسیر (path)stringالزامیمخصوص مهوششناسهٔ تیم.
X-Request-IDHeaderstringاختیاریمخصوص مهوششناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
X-Mahvash-ProjectHeaderstringاختیاریمخصوص مهوشslug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.

Request

curl -X DELETE 'https://api.mahvashai.ir/api/v1/tenancy/teams/<team_id>' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT"

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTPتوضیحات
200request با موفقیت انجام شد.
400request نامعتبر است.
401اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403دسترسی لازم را ندارید.
404منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429از سقف مجاز عبور کرده‌اید.
500خطای داخلی سرور.

حذف عضو از تیم

DELETE/api/v1/tenancy/teams/{team_id}/members/{membership_id}
آدرس پایهٔ APIhttps://api.mahvashai.ir
احراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

ناممحل ارسالنوعالزامیپشتیبانیتوضیحات
team_idمسیر (path)stringالزامیمخصوص مهوششناسهٔ تیم.
membership_idمسیر (path)stringالزامیمخصوص مهوششناسهٔ عضویت.
X-Request-IDHeaderstringاختیاریمخصوص مهوششناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
X-Mahvash-ProjectHeaderstringاختیاریمخصوص مهوشslug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.

Request

curl -X DELETE 'https://api.mahvashai.ir/api/v1/tenancy/teams/<team_id>/members/<membership_id>' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT"

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTPتوضیحات
200request با موفقیت انجام شد.
400request نامعتبر است.
401اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403دسترسی لازم را ندارید.
404منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429از سقف مجاز عبور کرده‌اید.
500خطای داخلی سرور.

فهرست تیم‌ها

GET/api/v1/tenancy/teams
آدرس پایهٔ APIhttps://api.mahvashai.ir
احراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

ناممحل ارسالنوعالزامیپشتیبانیتوضیحات
searchQuerystringاختیاریمخصوص مهوشجست‌وجو در نام، slug و توضیح تیم، بدون حساسیت به حروف بزرگ و کوچک.
statusQuerystringاختیاریمخصوص مهوشفیلتر بر اساس ACTIVE یا ARCHIVED.
pageQueryintegerاختیاریمخصوص مهوششمارهٔ صفحه (از ۱)، وقتی صفحه‌بندی می‌خواهید.
page_sizeQueryintegerاختیاریمخصوص مهوشاندازهٔ صفحه از ۱ تا ۱۰۰، وقتی صفحه‌بندی می‌خواهید.
X-Request-IDHeaderstringاختیاریمخصوص مهوششناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
X-Mahvash-ProjectHeaderstringاختیاریمخصوص مهوشslug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.

Request

curl -X GET 'https://api.mahvashai.ir/api/v1/tenancy/teams' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT"

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTPتوضیحات
200request با موفقیت انجام شد.
401اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403دسترسی لازم را ندارید.
404منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429از سقف مجاز عبور کرده‌اید.
500خطای داخلی سرور.