Открытый пакет интеграций

4 17 апреля 2024 09:01

bayselonarrend

API OneScript Интеграция open-source Расширение

Набор инструментов для интеграции с некоторыми популярными API посредством CLI, 1C:Enterprise или OneScript

Logo

Открытый пакет интеграций

Репозиторий на GitHub: https://github.com/Bayselonarrend/OpenIntegrations

ОПИ - open-source набор инструментов для интеграции с некоторыми популярными API посредством 1С:Предприятие, OneScript и CLI. Проект состоит из общих модулей, каждый из которых отвечает за свой API, а также нескольких модулей-инструментов, общих для всех библиотек. Реализованные методы выполняют конечные задачи (вроде ОтправитьСообщение или СоздатьПост), что позволяет использовать их без углубления в реализацию. Однако, код, при этом, достаточно сильно декомпозирован - методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы, даже если они еще не реализованы в самой библиотеке на текущий момент.

На данный момент реализованы методы для работы со следующими API: Telegram, VK, Viber, Notion, Twitter, Google Drive, Google Calendar, Yandex.Disk

Релизы

Code
Релизы библиотеки выходят в пяти вариантах:

Как CLI приложение для Windows и Linux (exe, rpm, deb)
Как XML файлы расширения для загрузки через конфигуратор
Как EDT проект расширения
Как отдельный файл расширения формата cfe (>8.3.9)
Как OneScript пакет расширения ospx

При использовании версий для 1С и OneScript, вы также можете просто скопировать код общих модулей из релизов в свой проект руками. Однако, вне зависимости от выбранного сопособа установки, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.

Для начала работы в OneScript дополнительно необходимо установить пакет

Из хаба пакетов:

    opm install oint

Или из скачанного ospx файла:

    opm install -f ./OInt-x.x.x.ospx

CLI версия дополнительно требует .Net Framework 4.8 или Mono соответствующей версии. При установке из rpm или deb пакетов устанавливается автоматически

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

У ОПИ есть подробная документация с примерами по адресу https://opi.neocities.org. Там вы можете найти как общие положения о начале работы с каждым конкретным API, так и описания каждого метода с примерами кода, параметров и возвращаемых значений.
Docs

CLI версия ОПИ имеет собственную встроенную справку по всем методам. Показ справки осуществляется при вызове библиотеки без метода, метода без опций или при указании опции --help

Открытый Пакет интеграций (OpenIntegrations)

Licensed under the MIT License

Список зависимостей находится в файле NOTICE

Не забудьте поставить звездочку на Github 😃