1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-25 02:42:28 +02:00
ОПИ - пакет библиотек для интеграции с API популярных сервисов
Go to file
2024-12-18 21:17:37 +03:00
.github Main build (Jenkins) 2024-12-15 11:14:30 +03:00
ci Фикс перевода 2024-12-18 20:51:42 +03:00
docs Main build (Jenkins) 2024-12-18 19:27:00 +03:00
media Update os-logo.json 2024-12-18 21:16:16 +03:00
service Main build (Jenkins) 2024-12-18 19:27:00 +03:00
src Фикс перевода 2024-12-18 20:51:42 +03:00
.gitignore Скрипт сборки TCP 2024-12-12 22:26:33 +03:00
data.json.gpg Test data update (Jenkins) 2024-12-18 18:27:02 +03:00
LICENSE Update LICENSE 2024-02-22 22:23:04 +03:00
NOTICE Update NOTICE 2024-06-18 10:54:16 +03:00
README_ENG.md Update README_ENG.md 2024-12-18 21:06:15 +03:00
README.md Update README.md 2024-12-18 21:17:37 +03:00

This package is also available in English: Click!


Main Main-light

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

Версия OpenYellow OneScript


Набор инструментов интеграции с популярными 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, так и описания каждого метода с примерами кода, параметров и возвращаемых значений.

Docs

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



Infostart

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


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