תיעוד ה-API של TaskLeef

API מסוג REST לניהול משימות, פרויקטים ולוחות Kanban

עודכן לאחרונה:

− אימות

ה-API תומך בשתי שיטות אימות:

1. אימות באמצעות מפתח API (מומלץ)

Generate an API key from your Settings page and include it in the X-API-Key header:

curl -H "X-API-Key: your-api-key" \
  https://taskleef.com/api/todos

2. אסימון נושא JWT

עבור יישומים מבוססי דפדפן, בצע אימות דרך נקודת הקצה של ההתחברות:

curl -X POST https://taskleef.com/api/login \
  -H "Content-Type: application/json" \
  -d '{"username": "your-username", "password": "your-password"}'

לאחר מכן כלול את האסימון בבקשות הבאות:

curl -H "Authorization: Bearer your-jwt-token" \
  https://taskleef.com/api/todos

− משימות

GET/api/todos

קבל את כל המשימות עבור המשתמש המאומת.

curl -H "X-API-Key: your-api-key" \
  https://taskleef.com/api/todos
GET/api/todos/{id}

קבל משימה מסוימת לפי מזהה.

GET/api/inbox

קבל משימות שאינן משויכות לאף פרויקט.

POST/api/todos

צור משימה חדשה.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Buy groceries", "description": "Milk, eggs, bread"}' \
  https://taskleef.com/api/todos

גוף הבקשה

שדהסוגחובהתיאור
titlestringYesTodo title
descriptionstringNoDetailed description
dueDateISO 8601NoDue date/time
prioritystringNoLow, Medium, High, or Urgent
projectIdUUIDNoAssign to a project
PUT/api/todos/{id}

עדכן משימה קיימת.

PATCH/api/todos/{id}/complete

החלף את סטטוס השלמת המשימה.

curl -X PATCH -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"isCompleted": true}' \
  https://taskleef.com/api/todos/{id}/complete
DELETE/api/todos/{id}

מחק משימה.

POST/api/todos/{parentId}/subtasks

צור תת-משימה תחת משימת אב.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Subtask title"}' \
  https://taskleef.com/api/todos/{parentId}/subtasks

− פרויקטים

GET/api/projects

הצג את כל הפרויקטים עבור המשתמש המאומת.

POST/api/projects

צור פרויקט חדש.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Work Tasks", "description": "Tasks for work"}' \
  https://taskleef.com/api/projects
GET/api/projects/{id}

קבל פרויקט מסוים עם המשימות שלו.

PUT/api/projects/{id}

עדכן פרויקט.

DELETE/api/projects/{id}

מחק פרויקט (המשימות מועברות לתיבת הדואר הנכנס).

− לוחות Kanban

GET/api/boards

הצג את כל הלוחות שלמשתמש יש גישה אליהם.

POST/api/boards

צור לוח חדש.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Sprint Board", "projectId": "project-uuid"}' \
  https://taskleef.com/api/boards
GET/api/boards/{id}

קבל לוח מסוים.

GET/api/boards/{boardId}/columns

קבל את כל העמודות של לוח.

GET/api/boards/{boardId}/todos

קבל את כל המשימות שיש להן כרטיסים בלוח זה.

− עמודות

POST/api/boards/{boardId}/columns

צור עמודה חדשה בלוח.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "In Progress", "wipLimit": 3}' \
  https://taskleef.com/api/boards/{boardId}/columns
PUT/api/columns/{id}

עדכן עמודה (כותרת, מגבלת WIP, קריטריון לסיום).

GET/api/columns/{columnId}/cards

קבל את כל הכרטיסים בעמודה.

DELETE/api/columns/{id}

מחק עמודה.

− כרטיסים

כרטיסים מייצגים משימות בלוח Kanban. למשימה יכולים להיות כרטיסים בכמה לוחות.

POST/api/columns/{columnId}/cards

צור כרטיס למשימה בעמודה.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"todoId": "todo-uuid"}' \
  https://taskleef.com/api/columns/{columnId}/cards
PUT/api/cards/{id}

עדכן כרטיס (העבר לעמודה או לתת-עמודה אחרת).

# Move card to a different column
curl -X PUT -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"columnId": "new-column-uuid", "subColumn": "Inbox"}' \
  https://taskleef.com/api/cards/{id}

# Move card to Done subColumn
curl -X PUT -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"subColumn": "Done"}' \
  https://taskleef.com/api/cards/{id}

ערכי תת-עמודה

  • Inbox - Active items in the column
  • Done - Completed items within the column
  • Blocked - Items waiting on external dependencies
DELETE/api/cards/{id}

הסר כרטיס מהלוח (אינו מוחק את המשימה).

− תגיות

GET/api/tags

הצג את כל התגיות עבור המשתמש המאומת.

POST/api/tags

צור תגית חדשה.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "urgent"}' \
  https://taskleef.com/api/tags
PUT/api/tags/{id}

עדכן תגית.

DELETE/api/tags/{id}

מחק תגית.

− תגובות

GET/api/todos/{todoId}/comments

קבל את כל התגובות על משימה.

POST/api/todos/{todoId}/comments

הוסף תגובה למשימה.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"text": "This is my comment"}' \
  https://taskleef.com/api/todos/{todoId}/comments
PUT/api/comments/{id}

עדכן תגובה.

DELETE/api/comments/{id}

מחק תגובה.

− פורמט התגובה

תגובות הצלחה

בקשות מוצלחות מחזירות JSON עם הנתונים המבוקשים:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Buy groceries",
  "description": "Milk, eggs, bread",
  "isCompleted": false,
  "createdAt": "2024-01-15T10:30:00Z"
}

תגובות שגיאה

שגיאות מחזירות קודי סטטוס HTTP מתאימים:

  • 400 - Bad Request (invalid input)
  • 401 - Unauthorized (missing or invalid authentication)
  • 403 - Forbidden (insufficient permissions)
  • 404 - Not Found
  • 500 - Internal Server Error

Need help? Check your Settings to manage API keys.