OpenIntegrations/README.md

This package is also available in English: Click!

---

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

Набор инструментов интеграции с популярными API: консольное приложение (Windows/Linux) и библиотека (расширение) для 1C:Enterprise/OneScript, состоящие из общего набора готовых функций для работы с онлайн-сервисами

Все реализованные методы из набора выполняют отдельные прикладные задачи, вроде ОтправитьСообщение или СоздатьПост, что позволяет использовать их без углубления в реализацию. Но код, при этом, достаточно сильно декомпозирован: методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы на основе уже существующих, не разматывая клубок реализации до самого начала работы с API.

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

Установка и варианты релизов

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

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

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

• Для начала работы в 1С достаточно скачать CFE файл (или XML выгрузку) расширения и загрузить его в список расширений своей конфигуарции
  

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

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

      opm install oint
  

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

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

• Для начала работы с CLI (приложением для командной строки) необходимо скачать из релизов Windows-установщик или один из вариантов пакета для Linux, в зависимости от используемой операционной системы. Дополнительно требуется наличие установленного .Net Framework 4.8 или Mono соответствующей версии (системные требования OneScript). При установке из rpm или deb пакетов устанавливается автоматически

  Также CLI версия доступна как пакет oint-cli, устанавливаемый из OPM

      opm install oint-cli
  

  При любом варианте установки, OInt CLI запускается командой oint из командной строки (при установке из Installer для Windows может потребоватья перезагрузка)

Warning

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

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

У ОПИ есть подробная документация с примерами по адресу https://openintegrations.dev. Там вы можете найти как общие положения о начале работы с каждым конкретным 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)
  
• Библиотека для работы с Google Sheets (open-source)
  
• Библиотека для работы с Airtable (open-source)
  
• Библиотека для работы с Dropbox (open-source)
  
• Мастерская ОПИ: большой мануал по работе с Telegram
  
• Библиотека для работы с Bitrix24: живая лента, задачи, файлы и личные сообщения
  
• Работа с онлайн сервисами из консоли через OInt CLI
  

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