Если вы не слышали ранее об Открытом Пакете Интеграций (что вполне вероятно), то небольшая вводная часть ниже, под катом. Для тех, кто уже знаком с ОПИ, данный раздел можно пропустить.
Открытый Пакет Интеграций (ОПИ) - это open-source набор методов для простой и быстрой интеграции с различными популярными API. Он состоит из аналогичных по функционалу 1С-расширения (CFE), OS-пакета и программы для Windows и Linux, которые предоставляют готовые функции для работы с целым набором различных онлайн-сервисов.
- ОПИ бесплатен и имеет открытый исходный код на GitHub. Вы всегда можете получить последнюю версию библиотеки на странице репозитория, а подписавшись - узнавать о выходе обновлений. Все релизы сопровождаются статьями на Инфостарт и разделами единой документации. На Инфостарт вы можете подписаться уже хоть сейчас, а про документацию я расскажу далее.
- Удобная единая документация. Она расположена на сайте opi.neocities.org и содержит в себе всю информацию, необходимую для работы: инструкции по предварительным действиям для начала интеграции, описания всех методов с параметрами и возвращаемыми значениями, примеры кода и т.д. Каждый API имеет там свой раздел.
- Простая установка. ОПИ распространяется во множестве вариантах: как XML файлы расширения, как EDT проект расширения, как файл расширения формата .cfe (версия 1С 8.3.9), как файл пакета для OneScript и еще в целом наборе пакетов и файлов для Windows и Linux. Из этого набора вы всегда сможете выбрать тот способ установки, который лучше подойдет для вашей конкретной задачи
На момент последнего обновления данной статьи, доступны следующие API:
Наиболее актуальную информацию можно посмотреть в репозитории или на вводной странице документации.
Slack - популярный корпоративный мессенджер, который часто используется как способ рабочего общения в рамках одной компании. Он имеет достаточно обширный API, который пока в ОПИ не реализован целиком, но подавляющее большинство основных методов уже доступно. А именно:
- Общие методы
- Получение информации о текущем боте
- Получение списка рабочих областей (команд)
- Получение списка пользователей
- Методы работы с сообщениями
- Отправка сообщения (моментально или отложенно)
- Отправка эфемерного сообщения
- Изменение сообщения
- Удаление сообщения
- Получение списка отложенных сообщений
- Получение ссылки на конкретное сообщение
- Получение списка ответов на выбранное сообщение
- Методы работы с каналами
- Получение списка доступных каналов
- Получение списка пользователей канала
- Создание канала
- Архивирование канала
- Получение информации о канале
- Получение истории канала
- Добавление пользователей в канал
- Исключение пользователей из канала
- Вступление в канал
- Выход из канала
- Установка темы канала
- Установка цели (описания) канала
- Переименование канала
- Методы работы с диалогами
- Открытие диалога (1-6 пользователей)
- Закрытие диалога
- Методы работы с файлами
- Получение списка файлов бота
- Загрузка файла на Slack
- Получение информации о файле
- Удаление файла
- Работа со внешними файлами
- Получение списка внешних файлов бота
- Получение информации о внешнем файле
- Добавление внешнего файла из URL
- Отправка внешнего файла в диалог
- Удаление внешнего файла
Вообще у Slack отличный API - может чуть сложнее чем у Telegram, но только в части разрешений и работы с токенами. Сам мессенджер, если что, выглядит как-то вот так
Подробную информацию о том, как же начать работать со Slack при помощи Открытого пакета интеграций, вы можете найти в соответствующем разделе нашей документации. В данной же статье отдельно про Slack рассказывать особенно нечего - все таки он не социальный мессенджер, как тот же Telegram, а корпоративный. Типо как Bitrix24. Следовательно, тем, кто его использует на работе, я ничего нового не расскажу, а персонально для своих личных целей он бесполезен. Так-то. Поэтому, лучше я расскажу немного о новостях проекта
Улучшение документации
Документация - важнейшая часть Открытого пакета интеграций. Если вы её еще не видели, но хотите использовать или уже используете ОПИ как часть своего проекта, то она расположена по адресу opi.neocities.org и целиком охватывает практически все методы, которые реализованы в пакете на данный момент. В данном релизе, помимо визуальной доработки, там появилось два нововведения
Во-первых - теперь есть глобальный поиск по документации. Библиотек и методов становится больше, так что рано или поздно он должен был там появиться. Сама поисковая строка находится в шапке сайта, вверху справа
Во-вторых - добавились новые подразделы в разделе о начале работы с библиотекой. Старая страница с общей информацией осталась, но теперь появились (и будут появляться далее) дочерние страницы о разных аспектах использования ОПИ. Сейчас это страница с описанием всех видов файлов релизов - на данный момент это уже целых 8 различных вариаций с разным назначением, что может вызывать вопросы. Данная же страница поможет разобраться, какой вид файла нужен именно вам.
А также появилась страница с кратким описанием работы OInt CLI, где чуть подробнее рассказывается о самом загадочном варианте поставки - приложении для Linux и Windows
Судя по статистике скачиваний, я точно могу сказать, что во всех релизах версия для OneScript (с тех пор, как она появилась) пользуется достаточной популярностью, но при этом есть большие сомнения, что все её пользователи пилят свои полноценные инструменты по мотивам. Веду я к тому, что если вам необходимо отправлять сообщения в Телеграм из батников или загружать логи из папки на Google Drive - решать прикладные задачи - то для этого куда проще и удобнее будет использовать CLI версию, чем каждый раз писать с нуля новые скрипты на OneScript. Новый инструмент всегда пугающе непонятный, но данная страница призвана помочь вам с этим - пока хотя бы в общих чертах
OPM и хаб пакетов
Между этим и прошлым релизами OneScript пакет ОПИ (oint) был добавлен в хаб пакетов. Это значит, что теперь для его использования можно не скачивать ospx файл из релиза, а просто использовать пакетный менеджер:
opm install oint
Благодаря этому теперь также нет проблем с обновлением oint до новой версии и указанием его в качестве зависимости для других пакетов
О комьюнити и в заключении
Последнее, но не по значимости - репозиторий Открытого пакета интеграций набрал уже 100+ звезд и 600+ скачиваний на GitHub. Большое спасибо за вашу поддержку. Напомню, что там (в репозитории) вы всегда можете задать вопрос, сообщить о баге или предложить новую идею для реализации. Все проблемы рассматриваются в Issues и решаются по мере возможности. Так, например, сегодняшняя библиотека - Slack - была сделана просто по просьбе пользователя из сообщества.
Еще хотелось бы напомнить про open-source в целом - уже сейчас (уже давно?) существует большое количество открытых проектов, которые вы можете использовать в своей работе или даже поучаствовать в их разработке. Когда-то я делал для таких проектов агрегатор - OpenYellow. Так вот он до сих пор работает и каждый день там обновляется информация о репозиториях из мира 1С - как на самом языке 1С, так и созданных с использованием других технологий. Вы точно сможете найти там интересные для себя проекты, и если найдете - не забудьте поддержать (хотя бы просто своим вниманием - звездочкой и подпиской)
Для тех, кто не читал эпиграф, также отдельно расскажу, что ОПИ - это не только Slack, но еще целая гора методов для работы с Telegram, Viber, Twitter, Notion, VK, Yandex Disk, Google Drive и Google Calendar
Спасибо за внимание!
Репозиторий ОПИ: github.com/Bayselonarrend/OpenIntegrations
Последний релиз: github.com/Bayselonarrend/OpenIntegrations/releases/latest
Другие статьи про Открытый пакет интеграций на Инфостарт:
Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter
Открытый пакет интеграций для OneScript
Мой GitHub: https://gitub.com/Bayselonarrend Лицензия MIT: https://mit-license.org
