4.3 KiB
| id | sidebar_class_name |
|---|---|
| Start | NachaloRaboty |
Welcome!
Open Integrations Package - is a set of tools for integration with some popular APIs via CLI, 1C, or OneScript. It consists of common modules, each responsible for its own API, as well as several utility modules that are common to all.
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.
Fast navigation:
Getting started
The library releases come in five variants:
- 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
Regardless of the chosen installation method, the files must be obtained from the Release section, as the repository files may contain intermediate data and functions that are still in development.
For more details about each release variant, see the section About Release Variants
Structure of modules
The project's common modules come in two types:
- Service
- OPI_Tools
- OPI_Cryptography
- Modules for direct interaction with APIs
- OPI_Telegram, OPI_VK...
:::warning It is not recommended to use the methods of utility modules in other parts of your configuration (if you plan to update to new versions in the future). To maintain backward compatibility, the number/purpose of parameters and the return types for API interaction methods do not change, but this does not apply to utility modules, which can be modified in any way for optimization and adaptation to new requirements. If you need functionality from the utility modules, it is recommended to copy it separately. :::