Что вы создадите

К концу этого руководства вы создадите плагин Интеллос, который:
  • Подключается к API сервиса заметок Flomo
  • Позволяет пользователям сохранять заметки из диалогов с ИИ напрямую в Flomo
  • Корректно обрабатывает аутентификацию и состояния ошибок
  • Готов к публикации в Интеллос Маркетплейс

Затраты времени

10 минут

Предварительные требования

Базовые знания Python и учётная запись Flomo

Шаг 1: установите Интеллос CLI и создайте проект

1

Установите Интеллос CLI

Проверьте установку:
2

Инициализируйте проект плагина

Создайте новый проект плагина командой:
Следуйте подсказкам, чтобы настроить плагин:
  • Назовите его «flomo»
  • Выберите «tool» в качестве типа плагина
  • Заполните остальные обязательные поля
3

Перейдите в каталог проекта

Так будет создана базовая структура плагина со всеми необходимыми файлами.

Шаг 2: опишите манифест плагина

Файл manifest.yaml определяет метаданные, разрешения и возможности вашего плагина.
Создайте файл manifest.yaml:

Шаг 3: создайте описание инструмента

Плагин-инструмент использует два файла YAML: файл провайдера, который объявляет учётные данные и перечисляет инструменты, и по одному файлу инструмента на каждый вызываемый инструмент. Полную схему смотрите в разделе Общие спецификации. Создайте provider/flomo.yaml:
Создайте tools/flomo.yaml:

Шаг 4: реализуйте основные вспомогательные функции

Создайте вспомогательный модуль utils/flomo_utils.py для взаимодействия с API:

Шаг 5: реализуйте провайдер инструмента

Провайдер инструмента отвечает за проверку учётных данных. Создайте provider/flomo.py:

Шаг 6: реализуйте инструмент

Класс инструмента выполняет фактические вызовы API, когда пользователь обращается к плагину. Создайте tools/flomo.py:
Всегда обрабатывайте исключения корректно и возвращайте понятные пользователю сообщения об ошибках. Помните, что ваш плагин представляет ваш бренд в экосистеме Интеллос.

Шаг 7: протестируйте плагин

1

Настройте среду отладки

Скопируйте пример файла окружения:
Укажите в файле .env параметры вашей среды Интеллос:
URL и ключ для отладки можно найти на панели управления Интеллос: нажмите значок Плагины в правом верхнем углу, затем нажмите значок отладки. Скопируйте API Key и Адрес хоста (адрес хоста уже включает порт).
2

Установите зависимости и запустите

Ваш плагин подключится к вашему экземпляру Интеллос в режиме отладки.
3

Проверьте работоспособность

В вашем экземпляре Интеллос перейдите к плагинам и найдите отлаживаемый плагин (помечен как «debugging»). Добавьте учётные данные API Flomo и проверьте отправку заметки.

Шаг 8: упакуйте и опубликуйте

Когда вы будете готовы поделиться плагином:
Эта команда создаёт файл plugin.difypkg, который можно загрузить в Интеллос Маркетплейс.

Частые вопросы и устранение неполадок

Убедитесь, что файл .env настроен правильно и вы используете корректный ключ отладки.
Ещё раз проверьте формат API URL Flomo. Он должен быть в виде: https://flomoapp.com/iwh/{token}/{secret}/
Убедитесь, что все необходимые файлы присутствуют и структура manifest.yaml корректна.

Итог

Вы создали рабочий плагин Интеллос, который подключается к внешнему API-сервису! Этот же подход работает для интеграции с тысячами сервисов — от баз данных и поисковых систем до инструментов для повышения продуктивности и пользовательских API.

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

Напишите README.md на английском (en_US) с описанием функциональности, настройки и примерами использования

Локализация

Создайте дополнительные файлы README, например readme/README_zh_Hans.md, для других языков

Редактировать эту страницу | Сообщить о проблеме