Installations
API مدیریت نصب ابزارک به توسعه‌دهندگان این امکان را می‌دهد که کنترل بر روی نصب ابزارک خود در میان کاربران داشته باشند. این مستندات شامل جزئیات مربوط به هر یک از عملیات موجود، پارامترهای مورد نیاز و نمونه‌هایی از درخواست‌ها و پاسخ‌ها است.
نصب ابزارک برای کاربران
برای نصب ابزارک برای یک یا چند کاربر، می‌توانید از درخواست POST به آدرس زیر استفاده کنید:
POST /api/v1/apps/:app_key/installations:app_key کلید منحصر به فرد ابزارک شما.
پارامترهای ورودی
| Field | Type | Description |
|---|---|---|
| user_ids | String[] | لیستی از شناسه کاربران |
مثال درخواست:
{
"user_ids": ["user1", "user2", "user3"]
}لغو نصب ابزارک برای کاربران
برای لغو نصب ابزارک از روی حساب یک یا چند کاربر، از درخواست DELETE به آدرس زیر استفاده کنید:
DELETE /api/v1/apps/:app_key/installations:app_key کلید منحصر به فرد ابزارک شما.
پارامترهای ورودی
| Field | Type | Description |
|---|---|---|
| user_ids | String[] | لیستی از شناسه کاربران |
مثال درخواست:
{
"user_ids": ["user1", "user2"]
}دریافت لیست کاربران نصب‌شده
برای دریافت لیست تمامی کاربرانی که ابزارک شما را نصب کرده‌اند، از درخواست GET به آدرس زیر استفاده کنید:
GET /api/v1/apps/:app_key/installations:app_key کلید منحصر به فرد ابزارک شما.
پارامترهای خروجی
| Field | Type | Description |
|---|---|---|
| user_ids | String[] | لیستی از شناسه کاربران |
مثال خروجی:
{
"user_ids": ["user1", "user2", "user3"]
}احراز هویت
تمامی درخواست‌ها باید شامل هدر X-API-KEY با یک توکن معتبر باشند.