رابط برنامه‌نویسی

مستندات API تسکیـ.دات‌آی‌آر

رابط برنامه‌نویسی RESTful برای یکپارچه‌سازی تسکیـ با ابزارهای داخلی سازمان، سیستم‌های خارجی و اتوماسیون فرآیندها.

HTTPS + JSON
Bearer Token
Rate Limiting
Webhooks

احراز هویت

احراز هویت از طریق Bearer Token انجام می‌شود. توکن API را از تنظیمات حساب کاربری دریافت و در هدر هر درخواست ارسال کنید.

Authorization: Bearer {token}

محدودیت نرخ

به‌منظور پایداری سرویس، محدودیت نرخ درخواست اعمال می‌شود. در صورت تجاوز، پاسخ 429 دریافت می‌کنید.

عمومی60 req/min
جستجو30 req/min
آپلود10 req/min

قراردادهای پایه

  • URL پایه: https://app.taskie.ir/api
  • تمام پاسخ‌ها به فرمت JSON هستند
  • شناسه‌ها از نوع عدد صحیح هستند
  • تاریخ‌ها به فرمت ISO 8601
  • خطاها با کد HTTP مناسب برگردانده می‌شوند

نمونه درخواست

دریافت لیست وظایف یک پروژه با فیلتر وضعیت

cURL
curl -X GET \
  "https://app.taskie.ir/api/projects/42/tasks?status=in_progress&per_page=20" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"
Response 200 OK
{
  "data": [
    {
      "id": 1284,
      "title": "طراحی رابط کاربری داشبورد",
      "status": { "id": 3, "name": "در حال انجام", "color": "#3B82F6" },
      "assignees": [{ "id": 7, "name": "سارا احمدی" }],
      "due_date": "2025-04-15T00:00:00.000Z",
      "priority": "high",
      "created_at": "2025-03-01T09:30:00.000Z"
    }
  ],
  "meta": { "total": 42, "per_page": 20, "current_page": 1 }
}

گروه‌های API

منابع اصلی در دسترس از طریق API

فضاهای کاری

مدیریت فضای کاری، اعضا و تنظیمات

  • GET /workspaces
  • POST /workspaces
  • PUT /workspaces/{id}
  • GET /workspaces/{id}/members

پروژه‌ها

ساخت، ویرایش و آرشیو پروژه‌ها

  • GET /projects
  • POST /projects
  • GET /projects/{id}
  • PUT /projects/{id}

وظایف

کامل‌ترین API برای مدیریت وظایف

  • GET /tasks
  • POST /tasks
  • GET /tasks/{id}
  • PUT /tasks/{id}
  • DELETE /tasks/{id}

اسپرینت

چرخه‌های اسپرینت و گزارش‌های چابک

  • GET /projects/{id}/sprints
  • POST /sprints
  • POST /sprints/{id}/start

نقشه ذهنی

ساختار و داده نقشه‌های ذهنی

  • GET /projects/{id}/mind-maps
  • POST /mind-maps
  • PUT /mind-maps/{id}/data

اهداف (OKR)

هدف‌گذاری و پیگیری شاخص‌ها

  • GET /goals
  • POST /goals
  • PUT /goals/{id}
  • POST /goals/{id}/targets

اتوماسیون

قوانین خودکار و اجرای تریگرها

  • GET /automations
  • POST /automations
  • POST /automations/{id}/toggle

اعضا و دعوت‌نامه

دعوت، نقش و مدیریت اعضای پروژه

  • GET /projects/{id}/members
  • POST /projects/{id}/members/invite
  • PUT /projects/{id}/members/{uid}

دسترسی به API

API تسکیـ در حال توسعه و پایدارسازی است. برای دریافت توکن دسترسی زودهنگام، محدودیت‌های طرح، یا مستندات فنی تفصیلی با تیم پشتیبانی در تماس باشید.