Документация API AI TMS

Базовые правила

• Базовый URL: https://tms.morozovbiz.ru
• Для интеграционных запросов передавайте API-ключ проекта в заголовке X-API-Key.
• Задача из Codex сохраняется только если поле description начинается с 1..
• После успешного создания TMS возвращает taskId, который используется для дальнейшей отправки результатов автотестов.

1. Создание задачи

Заголовки

X-API-Key: your_project_api_key
Content-Type: application/json

Тело запроса

{
  "description": "1. Добавить ссылку на документацию API в футер",
  "result": "",
  "status": "new",
  "external_ref": "codex-chat-123"
}

Поля

• description обязательное поле, должно начинаться с 1.
• result необязательное поле для предварительного результата или комментария
• status необязательное поле, допустимые значения: new, autotests, manual, ready
• external_ref необязательный внешний идентификатор, чтобы обновлять одну и ту же задачу повторными запросами
• attachment можно передавать как файл в multipart/form-data, поддерживаются изображения и видео

Успешный ответ

{
  "ok": true,
  "taskId": 17,
  "task": {
    "id": 17,
    "description": "1. Добавить ссылку на документацию API в футер",
    "status": "new"
  },
  "mode": "created"
}

Ответ при ошибке префикса

{
  "ok": false,
  "message": "Задача из Codex должна начинаться с \"1.\" и не будет сохранена без этого префикса"
}

2. Отправка отчета автотестов

Пример запроса

{
  "report": "Autotests passed: 24/24",
  "status": "autotests"
}

Успешный ответ

{
  "ok": true,
  "taskId": 17,
  "task": {
    "id": 17,
    "status": "autotests",
    "result": "Отчет автотестов:\nAutotests passed: 24/24"
  },
  "mode": "autotests_updated"
}

3. Пример cURL

curl -X POST "https://tms.morozovbiz.ru/api/integration/tasks" \
  -H "X-API-Key: your_project_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "1. Реализовать новую задачу",
    "external_ref": "codex-thread-42"
  }'

curl -X POST "https://tms.morozovbiz.ru/api/integration/tasks/17/autotests" \
  -H "X-API-Key: your_project_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "report": "Autotests passed: 12/12",
    "status": "autotests"
  }'

Админ API

Административные маршруты для логина, проектов и списка задач доступны только после авторизации в интерфейсе TMS. Публичной без логина остается именно эта страница документации и integration API по API-ключу проекта.