Что вы создадите
К концу этого руководства вы создадите плагин Интеллос, который:- Подключается к API сервиса заметок Flomo
- Позволяет пользователям сохранять заметки из диалогов с ИИ напрямую в Flomo
- Корректно обрабатывает аутентификацию и состояния ошибок
- Готов к публикации в Интеллос Маркетплейс
Затраты времени
10 минут
Предварительные требования
Базовые знания Python и учётная запись Flomo
Шаг 1: установите Интеллос CLI и создайте проект
1
Установите Интеллос CLI
- Mac
- Linux
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
Настройте среду отладки
Скопируйте пример файла окружения:Укажите в файле URL и ключ для отладки можно найти на панели управления Интеллос: нажмите значок Плагины в правом верхнем углу, затем нажмите значок отладки. Скопируйте API Key и Адрес хоста (адрес хоста уже включает порт).
.env параметры вашей среды Интеллос:2
Установите зависимости и запустите
3
Проверьте работоспособность
В вашем экземпляре Интеллос перейдите к плагинам и найдите отлаживаемый плагин (помечен как «debugging»).
Добавьте учётные данные API Flomo и проверьте отправку заметки.
Шаг 8: упакуйте и опубликуйте
Когда вы будете готовы поделиться плагином:plugin.difypkg, который можно загрузить в Интеллос Маркетплейс.
Частые вопросы и устранение неполадок
Плагин не появляется в режиме отладки
Плагин не появляется в режиме отладки
Убедитесь, что файл
.env настроен правильно и вы используете корректный ключ отладки.Ошибки аутентификации API
Ошибки аутентификации API
Ещё раз проверьте формат API URL Flomo. Он должен быть в виде:
https://flomoapp.com/iwh/{token}/{secret}/Не удаётся выполнить упаковку
Не удаётся выполнить упаковку
Убедитесь, что все необходимые файлы присутствуют и структура manifest.yaml корректна.
Итог
Вы создали рабочий плагин Интеллос, который подключается к внешнему API-сервису! Этот же подход работает для интеграции с тысячами сервисов — от баз данных и поисковых систем до инструментов для повышения продуктивности и пользовательских API.Документация
Напишите README.md на английском (en_US) с описанием функциональности, настройки и примерами использования
Локализация
Создайте дополнительные файлы README, например
readme/README_zh_Hans.md, для других языковРедактировать эту страницу | Сообщить о проблеме

