Что такое Kaiten bot?
Kaiten bot - это программа для автоматического выполнения поставленных задач. В данном случае, программа взаимодействует с "Kaiten" Что это такое и зачем он нужен можно почитать тут: "База знаний Кайтен"
Бот помогает управлять карточками в Kaiten непосредственно из мессенджера. Создаёт и удаляет карточки, генерирует описание, может устанавливать статусы, метки, перемещать карточки в другие столбцы и т.д.
С чего начать?
Для начала нужно найти бота среди пользователей мессенджера и написать ему, создав тем самым личный чат.
Если в ответ бот пришлёт сообщение вида:
"Приветствую! Для ознакомления используйте команду help"
Значит всё в порядке и бот готов исполнять команды.
Команды Kaiten bot
Стартовые:
- Login - команда авторизации бота в Kaiten.
Для успешной авторизации с помощью Login, у пользователя уже должен иметься готовый аккаунт в Kaiten. В нём нужно:
-
Зайти в настройки профиля, нажав на аватар и соответствующую кнопку в меню.
-
Найти пункт "Ключ доступа API" и нажать кнопку "Создать".
-
Полученный ключ скопировать и переслать его боту в сообщении следующего содержания:
@kaiten_bot login
token=(ключ копировать сюда)
domain=https://(нужный домен).kaiten.ru
"@kaiten_bot" - Обращение к боту, кому пересылаем команду. "login" - команда дающая понять боту что от него хочет пользователь. "token" - уникальный ключ аккаунта пользователя в Kaiten, дающий понять боту с каким аккаунтом ему предстоит работать. "domain" - адрес Kaiten в интернете с указанием нужной организации, в которой состоит целевой аккаунт. Если после отправки сообщения в ответ придёт:
Бот доступен. help Для знакомства с ботом выполните команду help
Значит логин прошёл успешно и все последующие команды будут обрабатываться с учётом этого статуса.
- Logout - команда выхода из аккаунта.
Для успешного выхода из аккаунта необходимо в переписке с ботом написать команду "Logout" Если бот в ответ на команду присылает:
Авторизация вашей учетной записи Kaiten была сброшена.
Если вы хотите продолжить использовать Kaitenbot, вам необходимо будет повторно пройти авторизацию.
Значит выход из аккаунта прошёл успешно.
- Set_params - Команда создающая набор настроек, по которым будет происходить работа с карточками в Kaiten.
Набор настроек включает в себя несколько последовательных этапов:
Создание пути.
Для того чтобы создать путь, необходимо задать название (Alias), указав его в следующей строке того же поста, после ввода команды. Название нужно для удобства последующих обращений бота к этому пути.
Например: В качестве названия пути пользователь указывает - "Карточки_в_Kaiten"
@kaiten_bot set_params
Карточки_в_Kaiten
В названиях нельзя использовать специальные символы, в том числе и пробелы, по этому, при необходимости, их нужно заменить нижним подчёркиванием, этот символ допускается.
Выбор пространства:
Если всё прошло штатно, в ответ бот должен запросить первую настройку и прислать:
Настройка пути [1/5]: Выберите Пространство
Пространство можно выбрать просто кликнув на предоставленный в ответе вариант.
После клика настройка будет применена, на что укажет следующее сообщение от бота.
Kaitenbot
Установлено пространство
Название: (То что вы выбрали из списка на предыдущем шаге)
Выбор доски:
Следующим пунктом бот запросит указать нужную доску
Kaitenbot
Настройка пути [2/5]: Выберите Доску
(Доступные варианты в пространстве казанном на предыдущем шаге)
Выбрать можно так же кликнув на искомый вариант
Kaitenbot
Установлена доска
Название: (Выбранная доска)
Выбор списка (столбца):
Теперь нужно указать список\столбец, в котором необходимо создать карточку, выбрав нужный и нажав на него.
Kaitenbot
Настройка пути [3/5]: Выберите Список
(названия списков)
Выбранный список применится а бот ответит:
Kaitenbot
Установлен список
Название: (название выбранного списка)
Выбор участника карточки:
В этом пункте бот запрашивает нужных участников, кого необходимо отметить в создаваемой карточке.
Kaitenbot
Настройка пути [4/5]: Выберите Участника карточки
В списке возможных участников будут все пользователи, которым разрешён доступ к целевой доске.
Выбор типа карточки:
Последним пунктом настройки, бот просит указать ему тип создаваемой карточки, выбор которго осуществляется нажатием на необходимый пункт из списка.
Kaitenbot
Настройка пути [5/5]: Выберите Тип карточки
После прохождения всех необходимых пунктов набор настроек будет применён.