API просторів, учасників і запрошень
Створюйте й змінюйте простори, переглядайте учасників, надсилайте запрошення та приймайте чи відхиляйте їх через API.
Перед початком
Базова адреса REST — https://tasker.fit/api. Створіть активний токен у профілі та передавайте Authorization: Bearer <your-api-token>. Замініть ID прикладів значеннями, отриманими для свого облікового запису.
Планування робочого процесу
REST API називає простір company та використовує company_id. Отримуйте ID зі списку замість назви. Участь у просторі визначає доступні проєкти й управлінські дії. Після зміни company_id зберігайте повернуте значення для наступних URL.
Запрошення адресовані наявному member_id з указаною роллю. invite_code є UUID для прийняття, відхилення чи відкликання. Дії одержувача виконуються від запрошеного облікового запису, керування — за управлінських прав. Зміна ролі приймає company_id і member_id у JSON, а не query.
Приклад
Створюйте й змінюйте простори, переглядайте учасників, надсилайте запрошення та приймайте чи відхиляйте їх через API.
Покрокові інструкції / 1
Процес інтеграції
Отримайте простори й виберіть company_id. Створюйте новий лише за потреби інтеграції.
Отримайте учасників чи знайдіть зареєстровані профілі для числових ID.
Створіть запрошення з роллю; одержувач приймає його за invite_code. Перевірте склад простору після прийняття.
Очікуваний результат: Прочитайте об’єкт data та збережіть ідентифікатори для наступних запитів. Перевіряйте HTTP-статус перед підтвердженням успіху запису.
Endpoint та приклади запитів
ID, токени й дати в прикладах замініть власними значеннями. Кожен приклад показує поля для конкретної дії, а не повну схему відповіді.
| Метод | Маршрут | Дія |
|---|---|---|
| GET | /company/list/ | Список доступних просторів |
| POST | /company/list/ | Створити простір |
| GET | /company/ | Отримати простір |
| PATCH | /company/ | Змінити дані простору |
| DELETE | /company/ | Видалити простір |
| GET | /company/members/ | Список учасників простору |
| PATCH | /company/members/ | Змінити роль учасника простору |
| GET | /member/search/ | Знайти зареєстрованих учасників |
| GET | /company/invites/ | Список запрошень простору |
| POST | /company/invites/ | Запросити зареєстрованого учасника |
| DELETE | /company/invites/ | Відкликати запрошення |
| GET | /member/company-invitations/ | Список власних запрошень |
| PATCH | /member/company-invitations/ | Прийняти запрошення |
| DELETE | /member/company-invitations/ | Відхилити запрошення |
/api/company/list/Список доступних просторів
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"page": 1,
"limit": 20
}Додаткові поля: q
Приклад cURL
curl --request GET 'https://tasker.fit/api/company/list/?page=1&limit=20' \
--header 'Authorization: Bearer <your-api-token>'/api/company/list/Створити простір
Потрібна автентифікація та права на операцію.
Тіло JSON (приклад)
{
"title": "Product team"
}Додаткові поля: description
Приклад cURL
curl --request POST 'https://tasker.fit/api/company/list/' \
--header 'Authorization: Bearer <your-api-token>' \
--header 'Content-Type: application/json' \
--data '{
"title": "Product team"
}'/api/company/Отримати простір
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"company_id": "demo"
}Приклад cURL
curl --request GET 'https://tasker.fit/api/company/?company_id=demo' \
--header 'Authorization: Bearer <your-api-token>'/api/company/Змінити дані простору
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"company_id": "demo"
}Тіло JSON (приклад)
{
"title": "Product team"
}Додаткові поля: company_id, description
Приклад cURL
curl --request PATCH 'https://tasker.fit/api/company/?company_id=demo' \
--header 'Authorization: Bearer <your-api-token>' \
--header 'Content-Type: application/json' \
--data '{
"title": "Product team"
}'/api/company/Видалити простір
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"company_id": "demo"
}Приклад cURL
curl --request DELETE 'https://tasker.fit/api/company/?company_id=demo' \
--header 'Authorization: Bearer <your-api-token>'/api/company/members/Список учасників простору
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"company_id": "demo"
}Додаткові поля: page, limit, q
Приклад cURL
curl --request GET 'https://tasker.fit/api/company/members/?company_id=demo' \
--header 'Authorization: Bearer <your-api-token>'/api/company/members/Змінити роль учасника простору
Потрібна автентифікація та права на операцію.
Тіло JSON (приклад)
{
"company_id": "demo",
"member_id": 12,
"role": "member"
}Приклад cURL
curl --request PATCH 'https://tasker.fit/api/company/members/' \
--header 'Authorization: Bearer <your-api-token>' \
--header 'Content-Type: application/json' \
--data '{
"company_id": "demo",
"member_id": 12,
"role": "member"
}'/api/member/search/Знайти зареєстрованих учасників
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"q": "alex",
"page": 1,
"limit": 20
}Приклад cURL
curl --request GET 'https://tasker.fit/api/member/search/?q=alex&page=1&limit=20' \
--header 'Authorization: Bearer <your-api-token>'/api/company/invites/Список запрошень простору
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"company_id": "demo"
}Приклад cURL
curl --request GET 'https://tasker.fit/api/company/invites/?company_id=demo' \
--header 'Authorization: Bearer <your-api-token>'/api/company/invites/Запросити зареєстрованого учасника
Потрібна автентифікація та права на операцію.
Тіло JSON (приклад)
{
"company_id": "demo",
"member_id": 12,
"role": "member"
}Приклад cURL
curl --request POST 'https://tasker.fit/api/company/invites/' \
--header 'Authorization: Bearer <your-api-token>' \
--header 'Content-Type: application/json' \
--data '{
"company_id": "demo",
"member_id": 12,
"role": "member"
}'/api/company/invites/Відкликати запрошення
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"invite_code": "<invite-uuid>"
}Приклад cURL
curl --request DELETE 'https://tasker.fit/api/company/invites/?invite_code=%3Cinvite-uuid%3E' \
--header 'Authorization: Bearer <your-api-token>'/api/member/company-invitations/Список власних запрошень
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"page": 1,
"limit": 20
}Приклад cURL
curl --request GET 'https://tasker.fit/api/member/company-invitations/?page=1&limit=20' \
--header 'Authorization: Bearer <your-api-token>'/api/member/company-invitations/Прийняти запрошення
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"invite_code": "<invite-uuid>"
}Приклад cURL
curl --request PATCH 'https://tasker.fit/api/member/company-invitations/?invite_code=%3Cinvite-uuid%3E' \
--header 'Authorization: Bearer <your-api-token>'/api/member/company-invitations/Відхилити запрошення
Потрібна автентифікація та права на операцію.
Параметри URL (приклад)
{
"invite_code": "<invite-uuid>"
}Приклад cURL
curl --request DELETE 'https://tasker.fit/api/member/company-invitations/?invite_code=%3Cinvite-uuid%3E' \
--header 'Authorization: Bearer <your-api-token>'Поради й вирішення проблем
- Приклади показують основні поля запиту, а не всі додаткові поля чи повну схему відповіді. Query-поля передавайте в URL, JSON-поля — у тілі. Зберігайте кінцеві слеші адрес.
- Значення ролей: owner, admin, project_manager, member, viewer. Прийняте запрошення надає участь у просторі; доступ до конкретної дошки додавайте окремо за потреби.
Поширені запитання
Чи можна використовувати приклади з будь-яким обліковим записом?
Читати й змінювати можна лише доступні токену ресурси. Використовуйте отримані ID просторів, дошок, завдань і числових ресурсів; демонстраційні значення є заповнювачами.
Що робити інтеграції при помилці запиту?
Перевірте HTTP-статус і відповідь помилки. Перевірте ID, обов’язкові поля, активність, строк токена та права. Не повторюйте POST наосліп: попередня спроба могла вже створити ресурс.