1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-21 01:50:24 +02:00
ОПИ - пакет библиотек для интеграции с API популярных сервисов
Go to file
Anton Titovets 4a6efd1182 Пины
2024-06-04 14:23:09 +03:00
.github Фиксы перевода версии для 1С 2024-06-04 11:03:30 +03:00
docs Обновление зашифрованных данных по результатам тестов (workflow) 2024-06-03 17:09:16 +00:00
Media Пины 2024-06-04 14:23:09 +03:00
service Подготовка релиза 2024-06-04 13:43:14 +03:00
src Преобразование OPI -> OInt (workflow) 2024-06-04 08:05:20 +00:00
.gitignore Обновление workflow для автодокументации 2024-05-28 10:37:56 +03:00
CHANGELOG.md Create CHANGELOG.md 2024-02-21 13:58:44 +03:00
CONTRIBUTING.md Create CONTRIBUTING.md 2024-05-31 10:42:30 +03:00
data.json.gpg Обновление зашифрованных данных по результатам тестов (workflow) 2024-06-03 17:09:16 +00:00
LICENSE Update LICENSE 2024-02-22 22:23:04 +03:00
NOTICE Update NOTICE 2024-03-28 09:31:36 +03:00
README.md Update README.md 2024-05-29 09:12:34 +03:00

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


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


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

    opm install oint

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

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

CLI версия требует .Net Framework 4.8 или Mono соответствующей версии. При установке из rpm или deb пакетов устанавливается автоматически


Warning

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

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

У ОПИ есть подробная документация с примерами по адресу https://openintegrations.dev. Там вы можете найти как общие положения о начале работы с каждым конкретным API, так и описания каждого метода с примерами кода, параметров и возвращаемых значений.

Docs

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



Infostart

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


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