mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-10-30 23:47:46 +02:00

Files

Anton Titovets 36662e79a4 Update README_ENG.md

2025-10-15 16:23:13 +03:00

9.5 KiB

Raw Blame History

Open Integrations Package

A set of integration tools 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 multiple well-known cloud services

All implemented methods from the set perform specific application tasks, such as SendMessage or CreatePost, allowing them to be used without deep diving into the implementation. However, the code is well-decomposed: authorization methods, data retrieval, etc., are separated into distinct functions where possible. This facilitates easy addition of new methods based on existing ones without unraveling the implementation chain from the very beginning of API interaction

📋 Currently implemented methods for working with the following services (list)

Usage Example

Sending an image to a Telegram chat from 1C/OneScript


    Token    = "6129457865:AAFyzNYOAFbu...";
    ChatID   = "461699897";
    Text     = "Cool pic";
    Picture  = "C:/picture.jpg";  // URL, disk path or Binary data

    Result = OPI_Telegram.SendImage(Token, ChatID, Text, Picture);

Same thing, but for CLI (bash example)

    oint telegram SendImage \
        --token "6129457865:AAFyzNYOAFbu..." \
        --chat 461699897 \
        --text "Cool pic" \
        --picture "picture.jpg"

To save the response in the console, you can use the standard > redirect or the --out <file path> option. For more detailed information on working with the CLI version, refer to the corresponding documentation section

Installation and Release Variants

The library releases are available in five variants

As CLI application for Windows and Linux (exe, rpm, deb)
As XML extension export
As EDT extension project
As standalone extension file in CFE format
As OneScript extension package in OSPX format

When using versions for 1C and OneScript, you can also manually copy common module code into your project. However, regardless of the chosen installation method, it is recommended to obtain files from Releases or the stable branch of the repository, as the source files in the main branch may contain intermediate data and functions under development.

Quick start options:

To start working in 1C: Simply download the CFE file (or XML export) of the extension and load it into your configuration's extensions list
To start working in OneScript: Install the package

From the package hub (RU version only):
```
    opm install oint
```
Or from a downloaded ospx file:
```
    opm install -f "./OInt-x.x.x.ospx"
```

To start working with CLI (command line application): Download from releases the Windows installer or one of the Linux package variants, depending on your operating system

Regardless of the installation method, OInt CLI is launched with the oint command from the command line (when installing via Windows Installer, a system reboot may be required).

Documentation

OpenIntegrations features comprehensive documentation with examples available at en.openintegrations.dev. Here 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.

The OpenIntegrations CLI version includes built-in help for all methods. Help is displayed when calling the library without a method, when calling a method without options, or when specifying the --help option.

Sponsors ?

The companies listed below support the development of the Open Integration Package and make significant contributions to its progress.



GreenAPI Stable WhatsApp API Gateway green-api.com 🌍

Support the Project

If you like this or my other projects, you can support me on Boosty (recurring or one-time). Subscriptions starting from 500 rubles provide access to a private Telegram chat where you can ask questions about the project and get direct help from me. There is also a sponsor subscription for companies with priority support and logo placement in the sponsors list.

Thank you for your support!

Open Integrations Package (OpenIntegrations)
Licensed under the MIT License

9.5 KiB Raw Blame History