1c/OpenIntegrations
1
0
Fork 0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-11-28 09:08:38 +02:00
Code Issues Releases Activity
ОПИ - пакет библиотек для интеграции с API популярных сервисов
419 Commits 1 Branch 24 Tags 254 MiB
1C Enterprise 99.9%
7204976470
Go to file
Anton Titovets 7204976470 Доработки по CLI: области, структура модуля, унификация
2024-03-20 14:52:23 +03:00
.github Update main.yml 2024-03-17 21:55:51 +03:00
cli Доработки по CLI: области, структура модуля, унификация 2024-03-20 14:52:23 +03:00
docs Мелкие фиксы 2024-03-17 19:08:26 +03:00
Media Drive в Readme 2024-03-17 21:08:56 +03:00
OInt Update lib.config 2024-03-17 22:10:47 +03:00
OPI Update Module.bsl 2024-03-17 21:59:43 +03:00
.gitignore Начало CLI версии 2024-03-19 13:56:38 +03:00
CHANGELOG.md Create CHANGELOG.md 2024-02-21 13:58:44 +03:00
data.json.gpg Обновление зашифрованных данных по результатам тестов (workflow) 2024-03-18 05:56:50 +00:00
LICENSE Update LICENSE 2024-02-22 22:23:04 +03:00
NOTICE Create NOTICE 2024-02-02 11:02:16 +03:00
README.md Update README.md 2024-03-18 09:01:31 +03:00

README.md

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

Статус порога качества Версия OpenYellow


Набор библиотек для интеграции с некоторыми популярными API для 1C:Enterprise и OneScript

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

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


Релизы

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

  • Как XML файлы расширения для загрузки через конфигуратор
  • Как EDT проект расширения
  • Как отдельный файл расширения формата cfe
  • Как OneScript пакет расширения ospx.

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


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

    opm install ./OInt-1.0.0.ospx

Warning

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

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

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

Docs

Infostart

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

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