OpenIntegrations/README.md

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

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

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

На данный момент реализованы методы для работы со следующими API:

Релизы

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

• Как CLI приложение для Windows и Linux (exe, rpm, deb)
• Как XML файлы расширения для загрузки через конфигуратор
• Как EDT проект расширения
• Как отдельный файл расширения формата cfe
• Как 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 пакетов устанавливается автоматически

Warning

Не рекомендуется напрямую использовать методы служебных модулей (OPI_Инструменты, OPI_Криптография) в вашем проекте (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно.

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

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

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

---

Статьи на Инфостарте:

• Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter
  
• Библиотека для работы с Notion API (Open-source)
  
• Библиотека работы с Яндекс Диском: делаем простейший менеджер облака за 15 минут (Open-source)
  
• Открываем свою лавку на платформе VK Market
  
• Библиотека для работы с Google Calendar API (open-source)
  
• Telegram в режиме форума: делаем чаты комфортными
  
• Открытый пакет интеграция для OneScript
  
• Библиотека для работы с Google Drive API (open-source)
  
• OInt CLI - приложение Открытого пакета интеграций для командной строки
  
• Библиотека для работы со Slack (open-source)
  

• Открытый Пакет интеграций (OpenIntegrations)
  Licensed under the MIT License
  Список зависимостей находится в файле NOTICE