1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-27 02:43:54 +02:00
OpenIntegrations/README_ENG.md

137 lines
6.8 KiB
Markdown
Raw Normal View History

2024-12-18 20:06:15 +02:00
![Main](media/main.gif#gh-dark-mode-only#gh-dark-mode-only)
![Main-light](media/main-light.gif#gh-light-mode-only)
2024-06-07 16:10:47 +02:00
# Open Integrations Package
2024-12-18 20:30:23 +02:00
![Версия](https://img.shields.io/badge/1C_version-8.3.10-yellow)
2024-09-24 14:56:06 +02:00
[![OpenYellow](https://img.shields.io/endpoint?url=https://openyellow.org/data/badges/2/736878759.json)](https://openyellow.org/grid?data=top&repo=736878759)
2024-12-18 20:30:13 +02:00
[![OneScript](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/refs/heads/main/media/os-logo.json)](https://github.com/EvilBeaver/OneScript)
2024-06-07 16:10:47 +02:00
<br>
2024-11-02 09:25:33 +02:00
A set of tools for integration with popular APIs: console application (Windows/Linux) and library (extension) for 1C:Enterprise/OneScript, consisting of a common set of ready-made functions for working with many well-known cloud services <br>
2024-06-07 16:10:47 +02:00
<br>
2024-06-11 22:21:35 +02:00
The implemented methods perform specific tasks (such as ``SendMessage`` or ``CreatePost``), allowing them to be used without delving into the implementation details. However, the code is highly decomposed – authorization methods, data retrieval, etc., are separated into individual functions where possible. This makes it easy to add new methods, even if they are not yet implemented in the library at the current time. <br><br>
2024-06-07 16:10:47 +02:00
List of currently available APIs:
<br>
<div>
2024-12-18 20:06:15 +02:00
<a href="https://en.openintegrations.dev/docs/Instructions/Telegram/"><img src="media/Telegram.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Bitrix24/"><img src="media/Bitrix24.png?6" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/CDEK/"><img src="media/CDEK.png?6" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/VK/"><img src="media/VK.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/VKTeams/"><img src="media/VKTeams.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Viber/"><img src="media/Viber.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Ozon/"><img src="media/Ozon.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/S3/"><img src="media/S3.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Twitter/"><img src="media/Twitter.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Notion/"><img src="media/Notion.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/YandexDisk/"><img src="media/YandexDisk.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/GoogleCalendar/"><img src="media/GoogleCalendar.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/GoogleDrive/"><img src="media/GoogleDrive.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/GoogleSheets/"><img src="media/GoogleSheets.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Slack/"><img src="media/Slack.png" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Airtable/"><img src="media/Airtable.png?6" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Dropbox/"><img src="media/Dropbox.png?6" width="40"></a>
<a href="https://en.openintegrations.dev/docs/Instructions/Neocities/"><img src="media/Neocities.png?6" width="40"></a>
2024-06-07 16:10:47 +02:00
</div>
<br>
2024-09-27 11:11:23 +02:00
## Work example
Sending picture to Telegram chat for 1C/OneScript
```bsl
Token = "6129457865:AAFyzNYOAFbu...";
ChatID = "461699897";
Text = "Cool pic";
2024-10-25 14:58:23 +02:00
Picture = "C:/picture.jpg"; // URL, disk path or Binary data
2024-09-27 11:11:23 +02:00
Result = OPI_Telegram.SendImage(Token, ChatID, Text, Picture);
```
Same thing, but for CLI (bash example)
```bash
oint telegram SendImage \
--token "6129457865:AAFyzNYOAFbu..." \
--chat 461699897 \
--text "Cool pic" \
--picture "picture.jpg"
```
You can use the standard `>` redirect or the oint's `--out` option to save the response in the console. For more details of working with the CLI version, see the corresponding [documentation section](https://en.openintegrations.dev/docs/Start/CLI_version)
<br>
2024-06-07 16:10:47 +02:00
## Releases ##
2024-08-20 10:28:38 +02:00
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/bayselonarrend/OpenIntegrations/total?logo=github)](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest)
2024-06-07 16:10:47 +02:00
2024-12-18 20:06:15 +02:00
<img src="media/icons.png" align="right">
2024-06-07 16:10:47 +02:00
<br><br>
#### The library releases come in five versions:
- As a CLI application for Windows and Linux (exe, rpm, deb)
- As XML extension files for loading via the configurator
- As an EDT extension project
- As a standalone extension file in cfe format
- As a OneScript extension package in ospx format
<br/><br>
2024-11-02 09:25:33 +02:00
When using the 1C and OneScript versions, you can also simply copy the code of common modules from the releases into your project by hand. However, regardless of the chosen installation method, you should get the files from Release, because the repository source files themselves contain intermediate data and functions under development.
2024-06-07 16:10:47 +02:00
<br/>
2024-11-02 09:25:33 +02:00
+ To start working in 1C it is enough to download the CFE file (or XML upload) of the extension and load it into the extensions list of your configuration <br>
+ To start working in OneScript, you need to install the package
2024-06-07 16:10:47 +02:00
2024-11-02 09:25:33 +02:00
From the package hub (RU version only):
```powershell
opm install oint
```
2024-06-07 16:10:47 +02:00
2024-11-02 09:25:33 +02:00
Or from a downloaded ospx file:
```powershell
opm install -f "./OInt-x.x.x.ospx"
```
2024-06-07 16:10:47 +02:00
<br>
2024-11-02 09:25:33 +02:00
+ To get started with the CLI (command line application), you need to download the Windows installer or one of the package variants for Linux from the releases, according to the operating system you are using
With any installation option, the OInt CLI is started with the `oint` command from the command line (installation from Installer for Windows may require a reboot)
2024-06-07 16:10:47 +02:00
<br/>
>[!WARNING]
2024-11-02 09:25:33 +02:00
>Also, there is a single exe-file delivery for the CLI application. To run it, .Net Framework 4.8 or the relevant version of Mono is required.
>This delivery option has performance issues, so we recommend using it only if it is impossible to use other variants on the target system
2024-06-07 16:10:47 +02:00
<br/>
2024-11-02 09:25:33 +02:00
2024-06-07 16:10:47 +02:00
## Documentation ##
OpenIntegrations has detailed documentation with examples available at [https://en.openintegrations.dev](https://en.openintegrations.dev). There you can find both general guidelines for getting started with each specific API and descriptions of each method with code examples, parameters, and return values.
2024-12-18 20:06:15 +02:00
![Docs](media/docs_eng.png?4)
2024-06-07 16:10:47 +02:00
The CLI version of OpenIntegrations has its own built-in help for all methods. The help is displayed when calling the library without a method, a method without options, or by specifying the `--help` option.
___
<br>
2024-12-18 20:06:15 +02:00
<img src="media/heartnstar.png?1" align="right" width="384">
2024-06-07 16:10:47 +02:00
<br>
2024-06-07 16:19:32 +02:00
>- Open Integrations Package (OpenIntegrations)<br>
2024-06-07 16:10:47 +02:00
>Licensed under the MIT License<br>