لیست تیم‌های حساب

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

آدرس درخواست :

GET
https://zaya.io/api/v1/teams

مثال ها :

# CURL Example:
curl --location --request GET 'https://zaya.io/api/v1/teams' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
# PHP Example:
$url = "https://zaya.io/api/v1/teams";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'Authorization: Bearer {api_key}'
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
$result = json_decode($result, true);

پاسخ ها :

200

{
    "data": [{
        "id": 123,
        "name": "My team",
        "role": "member",
        "permissions": ["links.index", "spaces.index"]
    }],
    "links": {
        "first": "string",
        "last": "string",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [{pagination}],
        "path": "https://zaya.io/api/v1/teams",
        "per_page": 10,
        "to": 1,
        "total": 1
    },
    "status": 200
}
401403

{
    "message": "string",
    "status": INTEGER
}

پارامتر ها :

نام
نوع
توضیحات
page
اختیاری integer
شماره صفحه نتایج؛ مقدار پیش‌فرض ۱ است.

استفاده از API برای تیم‌ها

با همان توکن Bearer حساب خود، از لیست تیم‌ها شناسه تیم را دریافت کنید. پارامتر اختیاری team_id را برای لیست، جزئیات، ساخت، ویرایش، حذف و آمار ارسال کنید. برای درخواست‌های GET و DELETE در query string و برای POST، PUT و PATCH در query string یا بدنه JSON ارسال شود.

GET
/api/v1/teams
GET
/api/v1/links?team_id=123
GET
/api/v1/links/456?team_id=123
GET
/api/v1/spaces?team_id=123
GET
/api/v1/spaces/789?team_id=123
GET
/api/v1/domains?team_id=123
GET
/api/v1/stats/456/total?team_id=123

در درخواست تیمی، منابع همان تیم مطابق مجوز شما نمایش داده می‌شوند. موضوع و دامنه انتخابی باید متعلق به همان تیم باشند؛ دامنه‌های عمومی مجاز نیز قابل استفاده‌اند. انتخاب تیم فقط برای همان درخواست است و تیم فعال پنل را تغییر نمی‌دهد.

بدون پارامتر جدید، لیست پیوندها شامل پیوندهای شخصی شما و پیوندهایی است که خودتان در تیم‌های مجاز ساخته‌اید. نمایش پیوندهای تیمی نیازمند مالکیت یا عضویت فعلی و مجوز مشاهده پیوندهاست؛ با لغو عضویت یا مجوز، این پیوندها از فهرست شما حذف می‌شوند و برای مدیریت در تیم باقی می‌مانند. در این حالت، موضوعات فقط شخصی هستند و لیست دامنه‌ها همچنان دامنه‌های تیم‌های عضو را نیز شامل می‌شود. برای انتخاب صریح منابع شخصی از scope=personal استفاده کنید. ارسال هم‌زمان آن با team_id مجاز نیست.

فیلد team_id در پاسخ پیوندها، موضوعات و دامنه‌ها شناسه تیم را نشان می‌دهد؛ مقدار null یعنی منبع شخصی یا دامنه عمومی. برای دریافت جزئیات پیوند تیمی، شناسه تیم را همراه شناسه پیوند ارسال کنید.

عضویت و مجوز هر عملیات و محدودیت‌های پلن تیم بررسی می‌شود. دعوت‌نامه پذیرفته‌نشده دسترسی ایجاد نمی‌کند. خطای 404 برای تیم یا منبع خارج از دسترسی، 403 برای نداشتن مجوز یا محدودیت پلن، و 422 برای پارامتر نامعتبر است.

نظرسنجی

آیا از امکانات زایا راضی هستید؟

خیلی ناراضی
ناراضی
معمولی
راضی
خیلی راضی

زایا همیشه در حال ارتقا سیستم و اضافه کردن امکانات کاربردی می باشد. نظرات شما باعت پیشرفت سیستم خواهد شد.