TaskLeef API-dokumentáció

REST API teendők, projektek és Kanban-táblák kezeléséhez

Utolsó frissítés:

− Hitelesítés

Az API kétféle hitelesítési módot támogat:

1. API-kulcsos hitelesítés (ajánlott)

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 bearer token

Böngészőalapú alkalmazásoknál a bejelentkezési végponton keresztül hitelesíts:

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

Ezután foglald bele a tokent a további kérésekbe:

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

− Teendők

GET/api/todos

A hitelesített felhasználó összes teendőjének lekérése.

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

Egy adott teendő lekérése azonosító alapján.

GET/api/inbox

Olyan teendők lekérése, amelyek nincsenek projekthez rendelve.

POST/api/todos

Új teendő létrehozása.

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

Kéréstörzs

MezőTípusKötelezőLeírás
titlestringYesTodo title
descriptionstringNoDetailed description
dueDateISO 8601NoDue date/time
prioritystringNoLow, Medium, High, or Urgent
projectIdUUIDNoAssign to a project
PUT/api/todos/{id}

Meglévő teendő frissítése.

PATCH/api/todos/{id}/complete

Teendő befejezettségi állapotának váltása.

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}

Teendő törlése.

POST/api/todos/{parentId}/subtasks

Részfeladat létrehozása egy szülő teendő alatt.

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

− Projektek

GET/api/projects

A hitelesített felhasználó összes projektjének listázása.

POST/api/projects

Új projekt létrehozása.

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}

Egy adott projekt lekérése a teendőivel együtt.

PUT/api/projects/{id}

Projekt frissítése.

DELETE/api/projects/{id}

Projekt törlése (a teendők a Beérkezett mappába kerülnek).

− Kanban-táblák

GET/api/boards

Az összes tábla listázása, amelyhez a felhasználónak hozzáférése van.

POST/api/boards

Új tábla létrehozása.

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}

Egy adott tábla lekérése.

GET/api/boards/{boardId}/columns

Egy tábla összes oszlopának lekérése.

GET/api/boards/{boardId}/todos

Az összes olyan teendő lekérése, amelynek kártyája van ezen a táblán.

− Oszlopok

POST/api/boards/{boardId}/columns

Új oszlop létrehozása egy táblán.

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}

Oszlop frissítése (cím, WIP-korlát, kész feltételek).

GET/api/columns/{columnId}/cards

Egy oszlop összes kártyájának lekérése.

DELETE/api/columns/{id}

Oszlop törlése.

− Kártyák

A kártyák a teendőket képviselik egy Kanban-táblán. Egy teendőnek több táblán is lehetnek kártyái.

POST/api/columns/{columnId}/cards

Kártya létrehozása egy teendőhöz egy oszlopban.

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}

Kártya frissítése (áthelyezés másik oszlopba vagy aloszlopba).

# 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}

Aloszlop-értékek

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

Kártya eltávolítása a tábláról (a teendőt nem törli).

− Címkék

GET/api/tags

A hitelesített felhasználó összes címkéjének listázása.

POST/api/tags

Új címke létrehozása.

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}

Címke frissítése.

DELETE/api/tags/{id}

Címke törlése.

− Hozzászólások

GET/api/todos/{todoId}/comments

Egy teendő összes hozzászólásának lekérése.

POST/api/todos/{todoId}/comments

Hozzászólás hozzáadása egy teendőhöz.

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}

Hozzászólás frissítése.

DELETE/api/comments/{id}

Hozzászólás törlése.

− Válaszformátum

Sikeres válaszok

A sikeres kérések JSON-t adnak vissza a kért adatokkal:

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

Hibaválaszok

A hibák megfelelő HTTP-állapotkódokat adnak vissza:

  • 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.