1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-11-24 08:52:18 +02:00
ОПИ - пакет библиотек для интеграции с API популярных сервисов
Go to file
2024-08-07 21:35:35 +03:00
.github Update МетодыФормированияТестовGA.os 2024-08-07 21:35:35 +03:00
docs Оформление доков 2024-08-01 09:14:39 +03:00
Media Стартовая страница Bitrix24 2024-06-20 13:33:21 +03:00
service Преобразование OPI -> OInt (workflow) 2024-08-07 18:38:32 +00:00
src Преобразование OPI -> OInt (workflow) 2024-08-07 12:16:15 +00:00
.gitignore Update .gitignore 2024-07-14 22:52:59 +03:00
data.json.gpg Обновление зашифрованных данных по результатам тестов (workflow) 2024-08-07 18:35:16 +00: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-08-05 09:01:52 +03:00
README.md Update README.md 2024-08-05 09:01:06 +03:00

This page, but on English, here: Click!


Main Main-light

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

Версия OpenYellow


Набор инструментов для интеграции с популярными API посредством CLI (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 или выгрузку и подключить расширение в свою конфигуарцию

  • Для начала работы в 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