This package is also available in English: Click!

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

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

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

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

Пример работы

Отправка картинки в чат Telegram из 1С/OneScript

    Токен    = "6129457865:AAFyzNYOAFbu...";
    IDЧата   = "461699897";
    Текст    = "Крутая картинка";
    Картинка = "C:/picture.jpg";  // URL, путь на диске или Двоичные данные

    Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDЧата, Текст, Картинка);

Тоже самое, но из CLI (пример для bash)

    oint telegram ОтправитьКартинку \
        --token "6129457865:AAFyzNYOAFbu..." \
        --chat 461699897 \
        --text "Крутая картинка" \
        --picture "picture.jpg"

Для сохранения ответа в консоли можно использовать стандартное перенаправление > или опцию --out <путь к файлу>. Более подробно работа с CLI версией изложена в соответствующем разделе документации

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

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

• Как 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, в зависимости от используемой операционной системы

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

     opm install oint-cli

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

[!WARNING] Также, для CLI приложения существует поставка единым exe-файлом. Для его запуска требуется .Net Framework 4.8 или Mono соответствующей версии. Данный вариант поставки имеет проблемы с производительностью, поэтому рекомендуется использовать его только в том случае, если использование других вариантов на целевой системе нежелательно или невозможно

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

У ОПИ есть подробная документация с примерами по адресу 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