1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-25 02:42:28 +02:00
OpenIntegrations/README.md

73 lines
6.9 KiB
Markdown
Raw Normal View History

2024-02-09 14:03:08 +02:00
<img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" style="height: 256px; width: 256px;">
2024-01-14 12:23:28 +02:00
# Открытый пакет интеграций
2024-01-14 15:45:32 +02:00
[![Статус порога качества](http://api.athenaeum.digital/Sonar/api/project_badges/measure?project=OpenIntegrations&metric=alert_status)](http://api.athenaeum.digital/Sonar/dashboard?id=OpenIntegrations)
2024-01-15 09:42:36 +02:00
![Версия](https://img.shields.io/badge/Версия_1С-8.3.9-yellow)
2024-02-03 18:08:52 +02:00
[![OpenYellow](https://img.shields.io/endpoint?url=https://openyellow.neocities.org/badges/2/736878759.json)](https://openyellow.notion.site/openyellow/24727888daa641af95514b46bee4d6f2?p=f78cea2066114067ab9069f06206219d&amp;pm=s)
2024-01-30 16:41:24 +02:00
2024-01-15 09:42:36 +02:00
<br>
2024-01-14 15:45:32 +02:00
Набор библиотек для интеграции с некоторыми популярными API для 1C:Enterprise. <br>
2024-01-14 12:23:28 +02:00
2024-01-14 15:45:32 +02:00
<br>
2024-02-25 12:53:44 +02:00
2024-01-14 16:52:10 +02:00
Проект состоит из общих модулей, каждый из которых отвечает за свой API, а также нескольких модулей-инструментов, общих для всех. Реализованные методы выполняют конечные задачи (вроде ОтправитьСообщение() или СоздатьПост()), что позволяет использовать их без углубления в реализацию. Однако, код, при этом, достаточно сильно декомпозирован - методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы, даже если они еще не реализованы в самой библиотеке на текущий момент. <br><br>
2024-01-14 12:23:28 +02:00
На данный момент реализованы методы для работы со следующими 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>
2024-01-29 00:54:23 +02:00
<a href="https://opi.neocities.org/docs/Notion/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/Notion.png" width="32"></a>
2024-02-11 21:52:25 +02:00
<a href="https://opi.neocities.org/docs/Yandex_Disk/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/YandexDisk.png" width="32"></a>
2024-02-25 22:27:41 +02:00
<a href="https://opi.neocities.org/docs/Google_Calendar/"><img src="https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/GoogleCalendar.png" width="32"></a>
2024-02-23 21:43:25 +02:00
</div>
2024-01-14 12:23:28 +02:00
<br>
2024-02-22 15:37:43 +02:00
2024-01-14 12:23:28 +02:00
## Релизы ##
2024-01-14 13:28:52 +02:00
Релизы библиотеки выходят в трех вариантах: как XML файлы расширения для загрузки через конфигуратор, как EDT проект расширения и как отдельный файл расширения формата cfe. Помимо этого, вы можете просто скопировать код общих модулей из релизов XML или EDT в свою конфигурацию вручную - метаданных других типов там нет. Вне зависимости от выбранного сопособа, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.
2024-01-14 12:23:28 +02:00
2024-01-14 13:28:52 +02:00
Общие модули проекта бывают двух видов:
- Служебные
- OPI_Инструменты
- OPI_Криптография
- Модули непосредственной работы с API
- OPI_Telegram, OPI_VK...
>[!WARNING]
>Не рекомендуется использовать методы служебных модулей в других местах вашей конфигурации (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно.
Список релизов можно найти в [Releases данного репозитория](https://github.com/Bayselonarrend/OpenIntegrations/releases).
2024-01-14 12:23:28 +02:00
## Документация ##
2024-01-14 13:28:52 +02:00
У ОПИ есть подробная документация с примерами по адресу [https://opi.neocities.org](https://opi.neocities.org). Там вы можете найти как общие положения о начале работы с каждым конкретным API, так и описания каждого метода с примерами кода и возвращаемых значений.
![Docs](https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/docs.png)
___
2024-01-14 16:50:13 +02:00
>![Infostart](https://github.com/Bayselonarrend/TelegramEnterprise/raw/main/infostart.svg)
>
2024-01-29 01:02:23 +02:00
>Статьи на Инфостарте:<br>
2024-02-26 15:32:25 +02:00
>- [Открытый пакет интеграций для популярных 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>
2024-02-02 10:09:16 +02:00
2024-02-26 15:32:25 +02:00
>- Открытый Пакет интеграций (OpenIntegrations)<br>
2024-02-02 10:12:23 +02:00
>Licensed under the MIT License<br>
2024-02-12 11:55:15 +02:00
>Список зависимостей находится в файле NOTICE<br>