1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-11-21 17:56:56 +02:00
ОПИ - пакет библиотек для интеграции с API популярных сервисов
Go to file
2024-02-22 22:23:04 +03:00
.github/ISSUE_TEMPLATE Delete .github/workflows/sonarqube.yml 2024-02-22 17:19:57 +03:00
docs Google Calendar: документация событий 2024-02-21 13:29:24 +03:00
Media Yandex Disk лого 2024-02-11 22:51:29 +03:00
OPI Деффекты SC 2024-02-19 21:09:13 +03:00
CHANGELOG.md Create CHANGELOG.md 2024-02-21 13:58:44 +03: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 Test action 2024-02-22 16:37:43 +03:00

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

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


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

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

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


Релизы

Релизы библиотеки выходят в трех вариантах: как XML файлы расширения для загрузки через конфигуратор, как EDT проект расширения и как отдельный файл расширения формата cfe. Помимо этого, вы можете просто скопировать код общих модулей из релизов XML или EDT в свою конфигурацию вручную - метаданных других типов там нет. Вне зависимости от выбранного сопособа, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.

Общие модули проекта бывают двух видов:

  • Служебные
    • OPI_Инструменты
    • OPI_Криптография
  • Модули непосредственной работы с API
    • OPI_Telegram, OPI_VK...

Warning

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

Список релизов можно найти в Releases данного репозитория.

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

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

Docs


Infostart

Статьи на Инфостарте:
Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter
Библиотека для работы с Notion API (Open-source)
Библиотека работы с Яндекс Диском: делаем простейший менеджер облака за 15 минут (Open-source)
Открываем свою лавку на платформе VK Market

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