Перейти к содержанию

Weeek Integration API 🔌

Интеграция с сервисом Weeek используется в двух направлениях:

  1. Internal API: Для глубокого взаимодействия Telegram-бота с задачами команды.
  2. Integrations API: Прокси-эндпоинты для отображения статуса задач прямо в этой документации.

🛠 Internal Weeek API (Telegram Bot)

Эти эндпоинты требуют заголовка X-Internal-Token и используются ботом для управления рабочим процессом.

1. Подключение аккаунта (/connect)

Привязывает Telegram Chat ID к API-токену Weeek.

  • URL: /internal/weeek/connect
  • Метод: POST
  • Body:
    {
      "telegram_chat_id": 12345678,
      "weeek_api_token": "your_token_here"
    }
    

2. Список задач (/tasks)

Получает задачи, назначенные на пользователя.

  • URL: /internal/weeek/tasks
  • Метод: GET
  • Параметры:
    • telegram_chat_id: ID чата ТГ.
    • type: all, today, tomorrow, overdue.

3. Управление задачей

  • Создание: POST /internal/weeek/tasks — создание новой задачи.
  • Перенос дедлайна: POST /internal/weeek/tasks/{id}/reschedule — меняет дату и добавляет комментарий с причиной.
  • Завершение: POST /internal/weeek/tasks/{id}/complete — отмечает задачу как выполненную.

🌐 Integrations API (Public Proxy)

Используется фронтендом документации для вставки виджетов с живым статусом задач.

1. Прокси задач (/weeek/tasks)

Позволяет получать список задач без раскрытия API-ключа на фронтенде.

  • URL: /api/v1/integrations/weeek/tasks
  • Метод: GET
  • Параметры: projectId, boardId, tagNames.

2. Дискавери (/weeek/discovery)

Вспомогательный эндпоинт для разработчиков, чтобы найти ID нужных проектов и досок.

  • URL: /api/v1/integrations/weeek/discovery
  • Метод: GET