Если вы не слышали ранее об Открытом Пакете Интеграций (что вполне вероятно), то небольшая вводная часть ниже, под катом. Для тех, кто уже знаком с ОПИ, данный раздел можно пропустить.
Открытый Пакет Интеграций (ОПИ) - это open-source набор методов для простой и быстрой интеграции с различными популярными API. Он состоит из аналогичных по функционалу 1С-расширения (CFE), OS-пакета и программы для Windows и Linux, которые предоставляют готовые функции для работы с целым набором различных онлайн-сервисов.
- ОПИ бесплатен и имеет открытый исходный код на GitHub. Вы всегда можете получить последнюю версию библиотеки на странице репозитория, а подписавшись - узнавать о выходе обновлений. Все релизы сопровождаются статьями на Инфостарт и разделами единой документации. На Инфостарт вы можете подписаться уже хоть сейчас, а про документацию я расскажу далее.
- Удобная единая документация. Она расположена на сайте opi.neocities.org и содержит в себе всю информацию, необходимую для работы: инструкции по предварительным действиям для начала интеграции, описания всех методов с параметрами и возвращаемыми значениями, примеры кода и т.д. Каждый API имеет там свой раздел.
- Простая установка. ОПИ распространяется во множестве вариантах: как XML файлы расширения, как EDT проект расширения, как файл расширения формата .cfe (версия 1С 8.3.9), как файл пакета для OneScript и еще в целом наборе пакетов и файлов для Windows и Linux. Из этого набора вы всегда сможете выбрать тот способ установки, который лучше подойдет для вашей конкретной задачи
На момент последнего обновления данной статьи, доступны следующие API:
Наиболее актуальную информацию можно посмотреть в репозитории или на вводной странице документации.
Bitrix24. Думаю, в представлении не нуждается: это крайне популярная отечественная CRM система, и особенно популярная там, где есть 1С
В текущем обновлении ОПИ появились методы для работы с данным сервисом - достаточно много, но не настолько, чтобы покрыть весь его доступный функционал. Однако, к текущему моменту, с большего, уже готово несколько достаточно крупных блоков, которые можно использовать в работе, а именно
- Работа с задачами
- Работа с новостями
- Работа с чатами, диалогами и сообщениями
- Работа с файлами
Как правило, в начале статьей про обновления, я привожу список всех новых реализованных методов. Но сейчас их оказалось довольно много, так что пришлось указывать их с делением по тематике
Для наглядности, ниже приведено несколько простых примеров работы с данными методами
Способы авторизации
При использовании любого из доступных методов, необходимо авторизовать себя в Bitrix24, для чего во всех функциях библиотеки есть параметры URL и Токен. Но их заполнение может отличаться - это зависит от выбранного способа авторизации, которых поддерживается два: Webhook и Локальное приложение:
- При использовании Webhook, достаточно передавать в параметр URL адрес вашего веб-хука
- При использовании Локального приложения, в URL передается основной адрес вашего Bitrix24 без дополнительных параметров, а в Токен - токен приложения
Подробнее о настройке и начале использования обоих этих методов вы можете узнать в документации
Изменения в документации. Снова
Для новых пользователей, которые не знакомы с ОПИ, отмечу, что у проекта есть большая подробная документация. Она находится по адресу openintegrations.dev и там вы можете найти все необходимое, начиная от инструкций по началу работы с понравившимся API, заканчивая примерами кода и списком параметров под каждый метод библиотеки отдельно
Для тех же, кто уже знаком с ОПИ, отмечу, что в документации опять произошли некоторые изменения. Во-первых, сервисы на боковой панели теперь делятся по разделам, так как они перестают влезать в высоту экрана. Во-вторых, теперь на страницах методов есть ссылки на оригинальную документацию API. Вернее они должны там быть: сейчас это актуально для Bitrix24, но в процессе они дозаполнятся и для остальных сервисов
Скачивание и обратная связь
Думаю, необходимо посвятить немного времени путеводителю по репозиторию проекта, так как Github все еще остается новой платформой в нашем сообществе, и работа с ним может вызывать вопросы у многих пользователей
Проект ОПИ распространяется на GitHub - найти его там можно по адресу github.com/Bayselonarrend/OpenIntegrations. Это страница его репозитория. Перейдя туда вы увидите структуру файлов и, ниже, основную информацию о проекте. Если вы хотите просто скачать расширение для 1С, то вам необходимо перейти на страницу Releases, ссылка на которую есть на правой панели (картинки будут ниже). Там, пролистав чуть ниже, будет блок Скачать/Download, а одним из пунктов в нем - CFE. На него просто необходимо нажать
Кстати, кроме CFE, у проекта есть другие варианты релизов: возможно, вас также сможет заинтересовать пакет для OneScript или приложение для командной строки, которое позволяет выполнять любые методы пакета без привязки к 1С. Подробнее об этом можно узнать здесь
Кроме скачивания, функционал Github еще позволяет сообщать о проблемах или пожеланиях, связанных с проектом, прямо внутри репозитория. Для этого есть вкладка Issues, перейдя на которую можно открыть новое обращение по интересующему вас вопросу. Это самый предпочтительный способ коммуникации в рамках проекта, так как он позволяет сохранять историю проблем и решений в одном месте, а также обращаться к ней при необходимости
Так что, если вам нужна помощь в работе с ОПИ - обязательно пишите, но, желательно, именно в Issue. Сделать это можно, если у вас есть аккаунт Github, но, если нет, то пройти регистрацию не займет много времени. Все равно пора уже - там есть много всего интересного :)
Также не забывайте ставить звездочку этому и другим проектам, если они вам понравилась! Проектам это помогает в развитии, а вам - в отслеживании новостей о выходе новых версий
Спасибо за внимание!
Репозиторий ОПИ: github.com/Bayselonarrend/OpenIntegrations
Последний релиз: github.com/Bayselonarrend/OpenIntegrations/releases/latest
Другие статьи про Открытый пакет интеграций на Инфостарт:
Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter
Открытый пакет интеграций для OneScript
Мой GitHub: https://gitub.com/Bayselonarrend OpenYellow: https://openyellow.notion.site Лицензия MIT: https://mit-license.org
