پرش به محتوای اصلی

مستندات API

مرجع کامل REST API برای یکپارچه‌سازی پلتفرم کارانوا در برنامه‌های شما

احراز هویت

API کارانوا از احراز هویت توکن Bearer استفاده می‌کند. توکن دسترسی خود را در هدر Authorization هر درخواست قرار دهید.

دریافت توکن API

  1. 1به حساب کارانوا خود وارد شوید
  2. 2به تنظیمات > کلیدهای API بروید
  3. 3یک کلید API جدید ایجاد کنید
  4. 4توکن خود را کپی کرده و به صورت ایمن ذخیره کنید

مثال هدر Authorization

Authorization: Bearer your_access_token_here

API Endpoints

مرور تمام نقاط پایانی API موجود سازماندهی شده بر اساس دسته‌بندی

POST
/api/v1/auth/login

Authenticate user and receive access token

POST
/api/v1/auth/refresh

Refresh access token using refresh token

POST
/api/v1/auth/logout

Invalidate current session

نیاز به احراز هویت
GET
/api/v1/users/me

Get current user profile

نیاز به احراز هویت
PATCH
/api/v1/users/me

Update current user profile

نیاز به احراز هویت
GET
/api/v1/projects

List all projects for current organization

نیاز به احراز هویت
POST
/api/v1/projects

Create a new project

نیاز به احراز هویت
GET
/api/v1/projects/:id

Get project details by ID

نیاز به احراز هویت
PUT
/api/v1/projects/:id

Update project details

نیاز به احراز هویت
DELETE
/api/v1/projects/:id

Delete a project

نیاز به احراز هویت
GET
/api/v1/projects/:projectId/tasks

List all tasks in a project

نیاز به احراز هویت
POST
/api/v1/projects/:projectId/tasks

Create a new task

نیاز به احراز هویت
PATCH
/api/v1/tasks/:id

Update task details

نیاز به احراز هویت
GET
/api/v1/analytics/dashboard

Get dashboard analytics data

نیاز به احراز هویت
GET
/api/v1/analytics/reports

Generate custom analytics reports

نیاز به احراز هویت

امتحان کنید

نقاط پایانی API را به صورت تعاملی با playground API ما تست کنید

به زودی