1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-06 10:47:33 +02:00
OpenIntegrations/README.md
2024-09-11 16:06:48 +03:00

12 KiB

This package is also available in English: Click!


Main Main-light

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

Версия OpenYellow


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

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

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


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

GitHub Downloads (all assets, all releases)



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

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

Docs

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



Infostart

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


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