Skip to content

ОПИ - пакет библиотек для интеграции с API популярных сервисов

License

Notifications You must be signed in to change notification settings

JohnyDeath/OpenIntegrations

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Статус порога качества Строки кода Версия
Набор библиотек для интеграции с некоторыми популярными 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


В проекте используется механизм распаковки zip и gzip vbondarevsky/Connector

Copyright 2017-2023 Vladimir Bondarevskiy под Apache License, Version 2.0

https://github.com/vbondarevsky/Connector/


Используются методы HMAC SHA-256 и некоторые другие из БСП

Copyright (c) 2019, ООО 1С-Софт Все права защищены. Эта программа и сопроводительные материалы предоставляются в соответствии с условиями лицензии Attribution 4.0 International (CC BY 4.0) Текст лицензии доступен по ссылке: https://creativecommons.org/licenses/by/4.0/legalcode


Документация создана при помощи Docusaurus

Copyright (c) Facebook, Inc. and its affiliates.

https://github.com/facebook/docusaurus

Остальной проект распространяется под лицензией MIT


Infostart

Статьи на Инфостарте:
Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter
Работа с Notion API | Обновление Открытого пакета интеграций

About

ОПИ - пакет библиотек для интеграции с API популярных сервисов

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • 1C Enterprise 100.0%