mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2024-12-12 11:15:07 +02:00
86 lines
7.5 KiB
Markdown
86 lines
7.5 KiB
Markdown
<img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" style="height: 256px; width: 256px;">
|
|
|
|
# Открытый пакет интеграций
|
|
[![Статус порога качества](http://api.athenaeum.digital/Sonar/api/project_badges/measure?project=OpenIntegrations&metric=alert_status)](http://api.athenaeum.digital/Sonar/dashboard?id=OpenIntegrations)
|
|
![Версия](https://img.shields.io/badge/Версия_1С-8.3.9-yellow)
|
|
[![OpenYellow](https://img.shields.io/endpoint?url=https://openyellow.neocities.org/badges/2/736878759.json)](https://openyellow.notion.site/openyellow/24727888daa641af95514b46bee4d6f2?p=f78cea2066114067ab9069f06206219d&pm=s)
|
|
|
|
<br>
|
|
Набор библиотек для интеграции с некоторыми популярными API для 1C:Enterprise и OneScript <br>
|
|
|
|
|
|
<br>
|
|
|
|
Проект состоит из общих модулей, каждый из которых отвечает за свой API, а также нескольких модулей-инструментов, общих для всех. Реализованные методы выполняют конечные задачи (вроде ОтправитьСообщение() или СоздатьПост()), что позволяет использовать их без углубления в реализацию. Однако, код, при этом, достаточно сильно декомпозирован - методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы, даже если они еще не реализованы в самой библиотеке на текущий момент. <br><br>
|
|
|
|
На данный момент реализованы методы для работы со следующими API:
|
|
<br>
|
|
<div>
|
|
<a href="https://opi.neocities.org/docs/Telegram/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/Telegram.png" width="32"></a>
|
|
<a href="https://opi.neocities.org/docs/VK/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/VK.png" width="32"></a>
|
|
<a href="https://opi.neocities.org/docs/Viber/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/Viber.png" width="32"></a>
|
|
<a href="https://opi.neocities.org/docs/Twitter/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/Twitter.png" width="32"></a>
|
|
<a href="https://opi.neocities.org/docs/Notion/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/Notion.png" width="32"></a>
|
|
<a href="https://opi.neocities.org/docs/Yandex_Disk/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/YandexDisk.png" width="32"></a>
|
|
<a href="https://opi.neocities.org/docs/Google_Calendar/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/GoogleCalendar.png" width="32"></a>
|
|
<a href="https://opi.neocities.org/docs/Google_Drive/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/GoogleDrive.png" width="32"></a>
|
|
</div>
|
|
<br>
|
|
|
|
## Релизы ##
|
|
|
|
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/bayselonarrend/OpenIntegrations/total?logo=github)](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest)
|
|
|
|
Релизы библиотеки выходят в четырех вариантах:
|
|
- Как XML файлы расширения для загрузки через конфигуратор
|
|
- Как EDT проект расширения
|
|
- Как отдельный файл расширения формата cfe
|
|
- Как OneScript пакет расширения ospx.
|
|
|
|
Помимо этого, вы можете просто скопировать код общих модулей из релизов в свой проект вручную. Однако, вне зависимости от выбранного сопособа установки, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.
|
|
|
|
<br/>
|
|
|
|
Для начала работы в OneScript дополнительно необходимо установить пакет из скачанного ospx файла
|
|
|
|
```
|
|
opm install -f ./OInt-1.0.0.ospx
|
|
```
|
|
<br/>
|
|
|
|
>[!WARNING]
|
|
>Не рекомендуется напрямую использовать методы служебных модулей (OPI_Инструменты, OPI_Криптография) в вашем проекте (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно.
|
|
<br/>
|
|
|
|
|
|
## Документация ##
|
|
|
|
У ОПИ есть подробная документация с примерами по адресу [https://opi.neocities.org](https://opi.neocities.org). Там вы можете найти как общие положения о начале работы с каждым конкретным API, так и описания каждого метода с примерами кода и возвращаемых значений.
|
|
|
|
![Docs](https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/docs.png)
|
|
|
|
___
|
|
|
|
|
|
>![Infostart](https://github.com/Bayselonarrend/TelegramEnterprise/raw/main/infostart.svg)
|
|
>
|
|
>Статьи на Инфостарте:<br>
|
|
>- [Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter](https://infostart.ru/1c/articles/2016164/)<br>
|
|
>- [Библиотека для работы с Notion API (Open-source)](https://infostart.ru/1c/articles/2022254/)<br>
|
|
>- [Библиотека работы с Яндекс Диском: делаем простейший менеджер облака за 15 минут (Open-source)](https://infostart.ru/1c/articles/2038960/)<br>
|
|
>- [Открываем свою лавку на платформе VK Market](https://infostart.ru/public/2043994/)<br>
|
|
>- [Библиотека для работы с Google Calendar API (open-source)](https://infostart.ru/1c/articles/2049575/)<br>
|
|
>- [Telegram в режиме форума: делаем чаты комфортными](https://infostart.ru/1c/articles/2055811/)<br>
|
|
>- [Открытый пакет интеграция для OneScript](https://infostart.ru/1c/articles/2060307/)<br>
|
|
>- [Библиотека для работы с Google Drive API (open-source)](https://infostart.ru/1c/articles/2066469/)<br>
|
|
|
|
|
|
>- Открытый Пакет интеграций (OpenIntegrations)<br>
|
|
>Licensed under the MIT License<br>
|
|
>Список зависимостей находится в файле NOTICE<br>
|
|
|
|
|
|
|
|
|
|
|