18дел Документация

Интеграции

Дополнительные HTTP-методы интерфейса

Регистрация, пользователи, таймеры и доски за пределами API v1.

Ниже описаны существующие методы /api, которые использует интерфейс. Это совместимый интерфейс приложения; для новых интеграций предпочитайте типизированный API v1. Защищённые методы /api принимают сессию либо Bearer-токен, права проверяются сервером. При Origin, отличающемся от разрешённого сайта, изменяющий запрос может быть отклонён.

Пространство и сессии

  • POST /api/register: workspace, workspace_name, name, email, password. Создаёт новое пространство и первого администратора; вход выполняется отдельно.
  • POST /api/login: workspace, email, password. Устанавливает HttpOnly session cookie. На вход и регистрацию есть ограничения частоты.
  • POST /api/logout: завершает браузерную сессию.
  • GET /api/bootstrap: текущий пользователь/пространство, доступные очереди, статусы, доски, дашборды и свой таймер.
  • POST /api/password: old, password. Меняет свой пароль и завершает сессии.

Участники и токены

  • POST /api/users: name, email, password, role (по умолчанию member). Требует admin пространства.
  • PATCH /api/users/{id}: name, role или active. Требует admin пространства.
  • GET /api/tokens: список своих токенов без значений.
  • POST /api/tokens: name. Показывает новое значение token один раз.
  • DELETE /api/tokens/{id}: отзывает свой токен.

Процесс и время

  • POST /api/queues/{id}/statuses: name, category. Требует admin очереди.
  • POST /api/boards: name, queue_ids. Создаёт доску по доступным очередям.
  • POST /api/issues/{key}/timer: запускает свой таймер, требуется write.
  • POST /api/timer/stop: останавливает свой таймер и записывает время при write.
  • DELETE /api/timer: отменяет свой таймер без записи, в том числе после потери write.
  • DELETE /api/worklogs/{id}: удаляет запись времени согласно правам автора/admin.
  • POST /api/issues/{key}/links: target_key, kind (relates/blocks/duplicates). Требует write обеих очередей.
  • DELETE /api/dashboards/{id}: удаляет собственный дашборд.

Остальные операции с задачами, очередями, правами, комментариями, статистикой и дашбордами доступны через API v1. Здесь намеренно нет реальных паролей и cookie. Для автоматизации предпочтителен отдельный пользователь с минимальными правами и личным токеном.