Перейти к основному содержимому

REST API

NUBL предоставляет REST API для интеграции с внешними сервисами и автоматизации рабочих процессов.

Базовый URL

https://nubl.space/api

Аутентификация

Все запросы (кроме регистрации и входа) требуют JWT-токен в заголовке:

Authorization: Bearer <access_token>

Для операций внутри воркспейса дополнительно используется:

WS-Member-Token: <workspace_member_token>

Подробнее в разделе Аутентификация.

Формат ответов

API возвращает данные в формате JSON. Успешные ответы содержат данные напрямую, ошибки возвращаются в формате:

{
"statusCode": 400,
"reason": "validation.error",
"message": "Описание ошибки"
}

Разделы API

РазделБазовый путьОписание
Аутентификация/api/userРегистрация, вход, управление токенами
Воркспейсы/api/workspaceУправление воркспейсами и участниками
Доски/api/workspace/:id/boardУправление досками, колонками, тегами
Задачи/api/workspace/:id/taskCRUD задач, комментарии, назначения
Страницы/api/workspace/:id/pageИерархия страниц и контроль доступа

Коды ответов

КодОписание
200Успешный запрос
201Ресурс создан
400Ошибка валидации
401Не авторизован
403Доступ запрещён
404Ресурс не найден
500Внутренняя ошибка сервера