You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-11-23 22:05:15 +02:00
Main build (Jenkins)
This commit is contained in:
24
docs/en/md/Addons/Melezh.mdx
vendored
Normal file
24
docs/en/md/Addons/Melezh.mdx
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
id: Melezh
|
||||
sidebar_class_name: Melezh
|
||||
description: Melezh - серверная версия Открытого пакета интеграций для получения доступа к его библиотекам по HTTP
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, gateway, server, proxy]
|
||||
---
|
||||
|
||||
<img src={require('../../static/img/melezh_ico.png').default} width='64px' />
|
||||
|
||||
# Melezh
|
||||
|
||||
Серверная версия Открытого пакета интеграций, предоставляющая единый настраиваемый HTTP API для доступа к любым его библиотекам с возможностью установки значений по умолчанию, веб-консолью и встроенным логированием входящих запросов
|
||||
|
||||
## Принцип работы
|
||||
|
||||
Данный аддон устанавливается поверх `oint` - консольного приложения [Открытого пакета интеграций](https://github.com/Bayselonarrend/OpenIntegrations), и позволяет удаленно вызывать его методы по средством HTTP-запросов из любого места так, как это происходило бы в консоли на локальной машине. Melezh использует встроенный в OneScript сервер Kestrel для приема HTTP запросов, а затем интерпретирует их в команды `oint` для дальнейшего выполнения
|
||||
|
||||
Решение имеет гибкую систему настроек, позволяющую определить ограничения списка доступных команд и методов, а также установить значения параметров для выполнения команд по умолчанию. Имеется система логирования и встроенная веб-консоль для удобного управления
|
||||
|
||||
|
||||
> **[📘 Перейти к документации Melezh](/docs/Addons/Melezh/Overview)** <br/>
|
||||
> **[🏰 Перейти в репозиторий Melezh](https://github.com/Bayselonarrend/Melezh)**
|
||||
|
||||
54
docs/en/md/Addons/Melezh/Console-Interface/Argument-setting/Clear-handler-arguments.mdx
vendored
Normal file
54
docs/en/md/Addons/Melezh/Console-Interface/Argument-setting/Clear-handler-arguments.mdx
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: Clear handler arguments and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Clear handler arguments
|
||||
Deletes all previously values of the handler arguments
|
||||
|
||||
|
||||
|
||||
`Function ClearHandlerArguments(Val Project, Val HandlersKey) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Cleaning result
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ClearHandlerArguments \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ClearHandlerArguments ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
61
docs/en/md/Addons/Melezh/Console-Interface/Argument-setting/Get-handler-arguments.mdx
vendored
Normal file
61
docs/en/md/Addons/Melezh/Console-Interface/Argument-setting/Get-handler-arguments.mdx
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: Get handler arguments and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Get handler arguments
|
||||
Gets the list of handler arguments
|
||||
|
||||
|
||||
|
||||
`Function GetHandlerArguments(Val Project, Val HandlersKey) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Handlers list
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh GetHandlerArguments \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh GetHandlerArguments ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"arg": "text",
|
||||
"strict": 1,
|
||||
"value": "Hello world!"
|
||||
}
|
||||
],
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
77
docs/en/md/Addons/Melezh/Console-Interface/Argument-setting/Set-handler-argument.mdx
vendored
Normal file
77
docs/en/md/Addons/Melezh/Console-Interface/Argument-setting/Set-handler-argument.mdx
vendored
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: Set handler argument and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Set handler argument
|
||||
Sets an argument to the handler function, allowing it to be unspecified when called
|
||||
|
||||
|
||||
|
||||
`Function SetHandlerArgument(Val Project, Val HandlersKey, Val Argument, Val Value, Val Strict = True) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
| Argument | --arg | String | ✔ | CLI argument (option) for the handler function |
|
||||
| Value | --value | String | ✔ | String argument value |
|
||||
| Strict | --strict | Boolean | ✖ | True > argument cannot be overwritten with data from the query |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Setting result
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh SetHandlerArgument \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "my-key" \
|
||||
--arg "text" \
|
||||
--value "Hello world!" \
|
||||
--strict true
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh SetHandlerArgument ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "my-key" ^
|
||||
--arg "text" ^
|
||||
--value "Hello world!" ^
|
||||
--strict true
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"data": {
|
||||
"active": 1,
|
||||
"function": "CreatePost",
|
||||
"key": "my-key",
|
||||
"library": "vk",
|
||||
"method": "FORM",
|
||||
"args": [
|
||||
{
|
||||
"arg": "text",
|
||||
"strict": 1,
|
||||
"value": "Hello world!"
|
||||
}
|
||||
]
|
||||
},
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
4
docs/en/md/Addons/Melezh/Console-Interface/Argument-setting/_category_.json
vendored
Normal file
4
docs/en/md/Addons/Melezh/Console-Interface/Argument-setting/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Argument setting",
|
||||
"position": "4"
|
||||
}
|
||||
62
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Add-requests-handler.mdx
vendored
Normal file
62
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Add-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: Add request handler and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Add request handler
|
||||
Adds a new handler to the project
|
||||
|
||||
|
||||
|
||||
`Function AddRequestsHandler(Val Project, Val OintLibrary, Val OintFunction, Val Method = "GET") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| OintLibrary | --lib | String | ✔ | Library name in CLI format |
|
||||
| OintFunction | --func | String | ✔ | OpenIntegrations function name |
|
||||
| Method | --method | String | ✖ | HTTP method to be processed by the handler: GET, JSON, FORM |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Result of handler modification
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh AddRequestsHandler \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--lib "telegram" \
|
||||
--func "SendTextMessage" \
|
||||
--method "get"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh AddRequestsHandler ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--lib "telegram" ^
|
||||
--func "SendTextMessage" ^
|
||||
--method "get"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"key": "4992c8a35",
|
||||
"url_example": "localhost:port/4992c8a35"
|
||||
}
|
||||
```
|
||||
58
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Delete-requests-handler.mdx
vendored
Normal file
58
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Delete-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: Delete request handler and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Delete request handler
|
||||
Removes the request handler from the project
|
||||
|
||||
|
||||
|
||||
`Function DeleteRequestsHandler(Val Project, Val HandlersKey) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Deleting result
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh DeleteRequestsHandler \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh DeleteRequestsHandler ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"tables": {
|
||||
"handlers": true,
|
||||
"arguments": true
|
||||
}
|
||||
}
|
||||
```
|
||||
54
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Disable-requests-handler.mdx
vendored
Normal file
54
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Disable-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: Disable request handler and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Disable request handler
|
||||
Disables the handler by key
|
||||
|
||||
|
||||
|
||||
`Function DisableRequestsHandler(Val Project, Val HandlersKey) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Switching result
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh DisableRequestsHandler \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "cdf15d862"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh DisableRequestsHandler ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "cdf15d862"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
54
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Enable-requests-handler.mdx
vendored
Normal file
54
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Enable-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: Enable request handler and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Enable request handler
|
||||
Enables the handler by key
|
||||
|
||||
|
||||
|
||||
`Function EnableRequestsHandler(Val Project, Val HandlersKey) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Switching result
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh EnableRequestsHandler \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "cdf15d862"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh EnableRequestsHandler ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "cdf15d862"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
62
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Get-requests-handler.mdx
vendored
Normal file
62
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Get-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: Get request handler and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Get request handler
|
||||
Gets information about the handler by key
|
||||
|
||||
|
||||
|
||||
`Function GetRequestsHandler(Val Project, Val HandlersKey) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Handlers information
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh GetRequestsHandler \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "cdf15d862"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh GetRequestsHandler ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "cdf15d862"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"data": {
|
||||
"active": 1,
|
||||
"function": "SendTextMessage",
|
||||
"key": "4992c8a35",
|
||||
"library": "telegram",
|
||||
"method": "GET",
|
||||
"args": []
|
||||
},
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
60
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Get-requests-handlers-list.mdx
vendored
Normal file
60
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Get-requests-handlers-list.mdx
vendored
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: Get request handlers list and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Get request handlers list
|
||||
Gets the list of handlers in the project
|
||||
|
||||
|
||||
|
||||
`Function GetRequestsHandlersList(Val Project) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Handlers list
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh GetRequestsHandlersList \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh GetRequestsHandlersList ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"active": 1,
|
||||
"function": "SendTextMessage",
|
||||
"key": "4992c8a35",
|
||||
"library": "telegram",
|
||||
"method": "GET"
|
||||
}
|
||||
],
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
65
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Update-handlers-key.mdx
vendored
Normal file
65
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Update-handlers-key.mdx
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
description: Update handlers key and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Update handlers key
|
||||
Replaces the handler key with a new one
|
||||
|
||||
|
||||
|
||||
`Function UpdateHandlersKey(Val Project, Val HandlersKey, Val NewKey = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
| NewKey | --key | String | ✖ | Your own key, if necessary. New standard UUID by default |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Handlers information
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh UpdateHandlersKey \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "a8b779075" \
|
||||
--key "***"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh UpdateHandlersKey ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "a8b779075" ^
|
||||
--key "***"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"data": {
|
||||
"active": 1,
|
||||
"function": "CreatePost",
|
||||
"key": "8ef003d30",
|
||||
"library": "vk",
|
||||
"method": "FORM",
|
||||
"args": []
|
||||
},
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
63
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Update-requests-handler.mdx
vendored
Normal file
63
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/Update-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: Update request handler and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Update request handler
|
||||
Changes the values of the request handler fields
|
||||
|
||||
|
||||
|
||||
`Function UpdateRequestsHandler(Val Project, Val HandlersKey, Val OintLibrary = "", Val OintFunction = "", Val Method = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| HandlersKey | --handler | String | ✔ | Handlers key |
|
||||
| OintLibrary | --lib | String | ✖ | Library name in CLI format |
|
||||
| OintFunction | --func | String | ✖ | OpenIntegrations function name |
|
||||
| Method | --method | String | ✖ | HTTP method to be processed by the handler: GET, JSON, FORM |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Result of changing the handler
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh UpdateRequestsHandler \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--handler "cdf15d862" \
|
||||
--lib "vk" \
|
||||
--func "CreatePost" \
|
||||
--method "FORM"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh UpdateRequestsHandler ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--handler "cdf15d862" ^
|
||||
--lib "vk" ^
|
||||
--func "CreatePost" ^
|
||||
--method "FORM"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
4
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/_category_.json
vendored
Normal file
4
docs/en/md/Addons/Melezh/Console-Interface/Handlers-configuration/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Handlers configuration",
|
||||
"position": "3"
|
||||
}
|
||||
53
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Create-project.mdx
vendored
Normal file
53
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Create-project.mdx
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: Create project and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Create project
|
||||
Creates a project file at the selected path
|
||||
|
||||
|
||||
|
||||
`Function CreateProject(Val Path) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Path | --path | String | ✔ | Project filepath |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Creating result
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh CreateProject \
|
||||
--path "C:\Users\bayselonarrend\AppData\Local\Temp\oxebtcco.ilx"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh CreateProject ^
|
||||
--path "C:\Users\bayselonarrend\AppData\Local\Temp\oxebtcco.ilx"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"message": "The project file has been successfully created!",
|
||||
"path": "C:\\Users\\bayselonarrend\\AppData\\Local\\Temp\\lv4rgf4d.bii"
|
||||
}
|
||||
```
|
||||
58
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Fill-project-settings.mdx
vendored
Normal file
58
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Fill-project-settings.mdx
vendored
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: Fill project settings and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Fill project settings
|
||||
Fills in the settings from the passed collection
|
||||
|
||||
|
||||
|
||||
`Function FillProjectSettings(Val Project, Val Settings) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| Settings | --set | Map Of KeyAndValue | ✔ | Collection key and value to fill in the settings |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Project settings list
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
# JSON данные также могут быть переданы как путь к файлу .json
|
||||
|
||||
melezh FillProjectSettings \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--set "{'logs_req_headers':false,'logs_req_body':false}"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
:: JSON данные также могут быть переданы как путь к файлу .json
|
||||
|
||||
melezh FillProjectSettings ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--set "{'logs_req_headers':false,'logs_req_body':false}"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
88
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Get-project-settings.mdx
vendored
Normal file
88
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Get-project-settings.mdx
vendored
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: Get project settings and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Get project settings
|
||||
Gets a list of all current project settings
|
||||
|
||||
|
||||
|
||||
`Function GetProjectSettings(Val Project) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Project settings list
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh GetProjectSettings \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh GetProjectSettings ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"description": "Web console login Password",
|
||||
"name": "ui_password",
|
||||
"value": "admin"
|
||||
},
|
||||
{
|
||||
"description": "Logs save path. To disable logging, set the value to empty",
|
||||
"name": "logs_path",
|
||||
"value": "C:/Users/bayselonarrend/AppData/Local/Temp/Melezh/cb82a741-27d0-4be9-acbb-5accf5bd2e7f"
|
||||
},
|
||||
{
|
||||
"description": "Logging of incoming request headers",
|
||||
"name": "logs_req_headers",
|
||||
"value": "true"
|
||||
},
|
||||
{
|
||||
"description": "Logging the body of incoming requests",
|
||||
"name": "logs_req_body",
|
||||
"value": "true"
|
||||
},
|
||||
{
|
||||
"description": "Disable logging logs_req_body for requests over this size (in bytes). 0 - no limitation",
|
||||
"name": "logs_req_max_size",
|
||||
"value": "104857600"
|
||||
},
|
||||
{
|
||||
"description": "Logging the body of outgoing responses",
|
||||
"name": "logs_res_body",
|
||||
"value": "true"
|
||||
},
|
||||
{
|
||||
"description": "Disable logging logs_res_body for requests over this size (in bytes). 0 - no limitation",
|
||||
"name": "logs_res_max_size",
|
||||
"value": "104857600"
|
||||
}
|
||||
],
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
32
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Run-project.mdx
vendored
Normal file
32
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Run-project.mdx
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: Run project and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Run project
|
||||
Runs an integration proxy server
|
||||
|
||||
|
||||
|
||||
`Function RunProject(Val Port, Val Project) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Port | --port | Number | ✔ | Server startup port |
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Server shutdown result
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
57
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Set-project-setting.mdx
vendored
Normal file
57
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Set-project-setting.mdx
vendored
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: Set project setting and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Set project setting
|
||||
Sets the value of the selected project setting
|
||||
|
||||
|
||||
|
||||
`Function SetProjectSetting(Val Project, Val Setting, Val Value) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| Setting | --key | String | ✔ | Project setting key |
|
||||
| Value | --value | String | ✔ | Value of project setting |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Setting result
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh SetProjectSetting \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--key "***" \
|
||||
--value "yo"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh SetProjectSetting ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--key "***" ^
|
||||
--value "yo"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
54
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Update-ui-password.mdx
vendored
Normal file
54
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/Update-ui-password.mdx
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: Update UI password and other functions to work with Melezh in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
||||
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Update UI password
|
||||
Changes the password for logging into the web console
|
||||
|
||||
|
||||
|
||||
`Function UpdateUIPassword(Val Project, Val Password) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Project | --proj | String | ✔ | Project filepath |
|
||||
| Password | --pass | String | ✔ | New password |
|
||||
|
||||
|
||||
Returns: Structure Of KeyAndValue - Result of password change
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh UpdateUIPassword \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" \
|
||||
--pass "***"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh UpdateUIPassword ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\anxujp4k.bmi" ^
|
||||
--pass "***"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
4
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/_category_.json
vendored
Normal file
4
docs/en/md/Addons/Melezh/Console-Interface/Projects-setup/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Projects setup",
|
||||
"position": "2"
|
||||
}
|
||||
62
docs/en/md/Addons/Melezh/Overview.mdx
vendored
Normal file
62
docs/en/md/Addons/Melezh/Overview.mdx
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: Overview
|
||||
sidebar_class_name: Info
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, HTTP, Melezh]
|
||||
---
|
||||
|
||||
# Добро пожаловать!
|
||||
|
||||

|
||||
|
||||
**Melezh** - это серверная версия Открытого пакета интеграций, предоставляющая единый настраиваемый HTTP API для доступа к любым его библиотекам с возможностью установки значений по умолчанию, веб-консолью и встроенным логированием входящих запросов
|
||||
|
||||
## Принцип работы
|
||||
|
||||
Данный сервер устанавливается поверх `oint` - консольного приложения [Открытого пакета интеграций](https://github.com/Bayselonarrend/OpenIntegrations), и позволяет удаленно вызывать его методы по средством HTTP-запросов из любого места так, как это происходило бы в консоли на локальной машине. Melezh использует встроенный в OneScript сервер Kestrel для приема HTTP запросов, а затем интерпретирует их в команды `oint` для дальнейшего выполнения
|
||||
|
||||
Решение имеет гибкую систему настроек, позволяющую определить ограничения списка доступных команд и методов, а также установить значения параметров для выполнения команд по умолчанию. Это позволяет как просто уменьшить количество передаваемых данных, так и скрыть чувствительные данные от клиентской стороны в случае необходимости
|
||||
|
||||
|
||||
## Пример начальной настройки
|
||||
|
||||
В этом примере создается новый файл проекта с настройкой обработкичка GET-запросов для функции `ОтправитьТекстовоеСообщение` из библиотеки работы с Telegram. Также в нем устанавливается значение по умолчанию для параметра `token` без возможности перезаписи ("строгий")
|
||||
|
||||
```powershell
|
||||
|
||||
melezh СоздатьПроект --path R:\test_proj.melezh
|
||||
melezh ДобавитьОбработчикЗапросов --proj R:\test_proj.melezh --lib telegram --func ОтправитьТекстовоеСообщение --method GET
|
||||
melezh УстановитьАргументОбработчика --proj R:\test_proj.melezh --handler 42281f11b --arg token --value "***" --strict true
|
||||
melezh ЗапуститьПроект --proj R:\test_proj.melezh --port 7788
|
||||
|
||||
```
|
||||
|
||||
Обработчик будет доступен на `localhost:7788/42281f11b`, где `42281f11b` - идентификатор, получаемый при вызове `ДобавитьОбработчикЗапросов`, являясь одновременно и ключем обработчика для настройки, и URL эндпоинтом для обращений
|
||||
|
||||
Пример запроса для отправки текстового сообщения:
|
||||
|
||||
```url
|
||||
http://localhost:7788/42281f11b?chat=123123123&text="Hello world!"
|
||||
```
|
||||
|
||||
Как вы могли заметить, мы не передаем токен, так как он установлен по умолчанию
|
||||
|
||||
## Web UI
|
||||
|
||||
Кроме CLI интерфейса, для более простой интерактивной настройки и управления, можно использовать встроенную в Melezh веб-консоль:
|
||||
|
||||

|
||||
|
||||
*На записи: вход в консоль, добавление нового обработчика для создания новости в Bitrix24 с указанием двух параметров по умолчанию, отключение двух обработчиков, просмотр подробностей одного из последних событий, просмотр всех логов по одному из обработчиков за сегодня*
|
||||
|
||||
<br/>
|
||||
|
||||
**Веб-консоль позволяет:**
|
||||
- Следить за последними событиями сервера
|
||||
- Добавлять, изменять и удалять обработчики, менять состав параметров по умолчанию
|
||||
- Включать и отключать обработчики на время
|
||||
- Просматривать подробные логи по каждому обработанному запросу
|
||||
- Изменять настройки сервера
|
||||
|
||||
Если вы только начинаете работу с Melezh, то рекомендуется начать именно с этого режима. Получить доступ к веб-консоли можно по адресу `localhost:<ваш порт>/ui` после создания и запуска проекта
|
||||
|
||||
|
||||
44
docs/en/md/Addons/Melezh/Start/First-start.mdx
vendored
Normal file
44
docs/en/md/Addons/Melezh/Start/First-start.mdx
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
id: First-start
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
title: Первый запуск и создание проекта
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
В этом разделе описан запуск и первые шаги после установки Melezh на устройстве
|
||||
|
||||
## Запуск
|
||||
|
||||
Вне зависимости от операционной системы и способа установки, после ее завршения, Melezh должен быть доступен в терминале (командной строке) по команде `melezh`.
|
||||
|
||||
|
||||
>На Windows может потребоваться перезагрузка, но также там присутствует возможность прямого запуска по ярлыку в меню "Пуск"
|
||||
|
||||
|
||||
После вызова, будет показан начальный экран `melezh`:
|
||||
|
||||

|
||||
|
||||
Вы можете получить список всех доступных методов Melezh, вызвавв команду `melezh --help`. Вызов любого метода Melezh без параметров возвращает справку о его назначении и наборе аргументов:
|
||||
|
||||

|
||||
|
||||
## Создание проекта
|
||||
|
||||
Для полноценного начала работы с Melezh необходимо создать **проект** - файл, в котором будут хранится основные настройки и данные об обработчиках. Для этого необходимо вызывать команду `СоздатьПроект` и указать путь в аргументе `--path`
|
||||
|
||||

|
||||
|
||||
<hr/>
|
||||
|
||||
## Настройка проекта
|
||||
|
||||
Дальнейшая настройка проекта может осуществляться двумя способами:
|
||||
|
||||
+ **В консольном варианте** <br/>
|
||||
Настройка проекта может осуществляться дальнейшим вызовом команд `melezh` в терминале (командной строке). Список доступных команд и их аргументы перечислены в разделе *Консольный интерфейс*
|
||||
|
||||
+ **В веб-панели управления** <br/>
|
||||
Кроме консольного интерфейса, Melezh имеет встроенный Web UI, позволяющий упралвять проектом в интерактивном режиме. Подробнее о работе через веб-интерфейс можно узнать в разделе *Web-интерфейс*
|
||||
|
||||
|
||||
45
docs/en/md/Addons/Melezh/Start/Installation.mdx
vendored
Normal file
45
docs/en/md/Addons/Melezh/Start/Installation.mdx
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: Installation
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
title: Установка
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
Для начала работы с Melezh необходимо пройти процедуру его установки, после чего создать и настроить проект. В этом разделе описан процесс установки Melezh на конкретном устройстве. Выбор того или иного способа зависит от операционной системы и наличия в ней OneScript с пакетным менеджером OPM:
|
||||
|
||||
## Windows
|
||||
|
||||
Установка Melezh на Windows осуществляется в процессе установки `oint` - основного консольного приложения Открытого пакета интеграций. Достаточно скачать установщики `oint` из релиза репозитория [OpenIntegrations](https://github.com/Bayselonarrend/OpenIntegrations) (v >= 1.24.0), после чего, в процессе установки, поставить флажок на странице с вопросом о дополнительной установке Melezh:
|
||||
|
||||

|
||||
|
||||
<hr/>
|
||||
|
||||
## Linux
|
||||
|
||||
Для установки Melezh на устройствах с ОС Linux, в релизах репозитория Melezh присутствуют `.deb` и `.rpm` пакеты. Оба они зависят от пакета `oint`, который в соответствующих вариантах можно найти в релизах репозитория [OpenIntegrations](https://github.com/Bayselonarrend/OpenIntegrations)
|
||||
|
||||
:::warning
|
||||
Melezh совместим с любой версией `oint`, выше 1.24.0, но при условии совпадения языков: и Melezh, и OInt поставляются в двух языковых вариантах - русском и английском, которые нельзя смешивать друг с другом. Т.е. русская версия Melezh может быть установлена только поверх русской версии OInt, а английская - только поверх английской, соответственно
|
||||
:::
|
||||
|
||||
<br/><hr/>
|
||||
|
||||
## OneScript
|
||||
|
||||
Melezh и OInt - это, в первую очередь, пакеты для [OneScript](https://github.com/EvilBeaver/OneScript), которые могут быть установлены при помощи пакетного менеджера OPM. Русская версия пакета может быть установлена из облачного хаба пакетов при помощи консольной команды:
|
||||
|
||||
```powershell
|
||||
opm install melezh
|
||||
```
|
||||
|
||||
В этом пакете уже прописаны зависимости от OInt - он будет установлен автоматически
|
||||
|
||||
Помимо этого, и английская, и русская версии могут быть установлены из `.ospx` файлов пакетов, которые находятся в релизах соответствующих репозиториев [Melezh](https://github.com/Bayselonarrend/OpenIntegrations) и [OpenIntegrations](https://github.com/Bayselonarrend/OpenIntegrations):
|
||||
|
||||
```powershell
|
||||
opm install -f oint.ospx
|
||||
opm install -f melezh.ospx
|
||||
```
|
||||
|
||||
Как и в случае с пакетами для Linux, важно соблюдать соответствие языков версий: русская версия Melezh может работать только в зависимости от русской версии OInt, а английская - в зависимости от английской
|
||||
24
docs/ru/md/Addons/Melezh.mdx
vendored
Normal file
24
docs/ru/md/Addons/Melezh.mdx
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
id: Melezh
|
||||
sidebar_class_name: Melezh
|
||||
description: Melezh - серверная версия Открытого пакета интеграций для получения доступа к его библиотекам по HTTP
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, gateway, server, proxy]
|
||||
---
|
||||
|
||||
<img src={require('../../static/img/melezh_ico.png').default} width='64px' />
|
||||
|
||||
# Melezh
|
||||
|
||||
Серверная версия Открытого пакета интеграций, предоставляющая единый настраиваемый HTTP API для доступа к любым его библиотекам с возможностью установки значений по умолчанию, веб-консолью и встроенным логированием входящих запросов
|
||||
|
||||
## Принцип работы
|
||||
|
||||
Данный аддон устанавливается поверх `oint` - консольного приложения [Открытого пакета интеграций](https://github.com/Bayselonarrend/OpenIntegrations), и позволяет удаленно вызывать его методы по средством HTTP-запросов из любого места так, как это происходило бы в консоли на локальной машине. Melezh использует встроенный в OneScript сервер Kestrel для приема HTTP запросов, а затем интерпретирует их в команды `oint` для дальнейшего выполнения
|
||||
|
||||
Решение имеет гибкую систему настроек, позволяющую определить ограничения списка доступных команд и методов, а также установить значения параметров для выполнения команд по умолчанию. Имеется система логирования и встроенная веб-консоль для удобного управления
|
||||
|
||||
|
||||
> **[📘 Перейти к документации Melezh](/docs/Addons/Melezh/Overview)** <br/>
|
||||
> **[🏰 Перейти в репозиторий Melezh](https://github.com/Bayselonarrend/Melezh)**
|
||||
|
||||
54
docs/ru/md/Addons/Melezh/Console-Interface/Argument-setting/Clear-handler-arguments.mdx
vendored
Normal file
54
docs/ru/md/Addons/Melezh/Console-Interface/Argument-setting/Clear-handler-arguments.mdx
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: Очистить аргументы обработчика и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Очистить аргументы обработчика
|
||||
Удаляет все установленные ранее значения аргументов обработчика
|
||||
|
||||
|
||||
|
||||
`Функция ОчиститьАргументыОбработчика(Знач Проект, Знач КлючОбработчика) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат очистки
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ОчиститьАргументыОбработчика \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ОчиститьАргументыОбработчика ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
55
docs/ru/md/Addons/Melezh/Console-Interface/Argument-setting/Get-handler-arguments.mdx
vendored
Normal file
55
docs/ru/md/Addons/Melezh/Console-Interface/Argument-setting/Get-handler-arguments.mdx
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: Получить аргументы обработчика и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Получить аргументы обработчика
|
||||
Получает список установленных аргументов обработчика
|
||||
|
||||
|
||||
|
||||
`Функция ПолучитьАргументыОбработчика(Знач Проект, Знач КлючОбработчика) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Список обработчиков
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ПолучитьАргументыОбработчика \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ПолучитьАргументыОбработчика ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"data": [],
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
77
docs/ru/md/Addons/Melezh/Console-Interface/Argument-setting/Set-handler-argument.mdx
vendored
Normal file
77
docs/ru/md/Addons/Melezh/Console-Interface/Argument-setting/Set-handler-argument.mdx
vendored
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: Установить аргумент обработчика и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Установить аргумент обработчика
|
||||
Устанавливает аргумент для функции обработчика, позволяя не указывать его при вызове
|
||||
|
||||
|
||||
|
||||
`Функция УстановитьАргументОбработчика(Знач Проект, Знач КлючОбработчика, Знач Аргумент, Знач Значение, Знач Строгий = Истина) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
| Аргумент | --arg | Строка | ✔ | CLI аргумент (опция) для функции обработчика |
|
||||
| Значение | --value | Строка | ✔ | Строковое значение аргумента |
|
||||
| Строгий | --strict | Булево | ✖ | Истина > аргумент не может быть перезаписан данными из запроса |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат установки
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh УстановитьАргументОбработчика \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--handler "my-key" \
|
||||
--arg "text" \
|
||||
--value "Hello world!" \
|
||||
--strict true
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh УстановитьАргументОбработчика ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--handler "my-key" ^
|
||||
--arg "text" ^
|
||||
--value "Hello world!" ^
|
||||
--strict true
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"data": {
|
||||
"active": 1,
|
||||
"function": "СоздатьПост",
|
||||
"key": "my-key",
|
||||
"library": "vk",
|
||||
"method": "FORM",
|
||||
"args": [
|
||||
{
|
||||
"arg": "text",
|
||||
"strict": 1,
|
||||
"value": "Hello world!"
|
||||
}
|
||||
]
|
||||
},
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
4
docs/ru/md/Addons/Melezh/Console-Interface/Argument-setting/_category_.json
vendored
Normal file
4
docs/ru/md/Addons/Melezh/Console-Interface/Argument-setting/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Установка аргументов",
|
||||
"position": "4"
|
||||
}
|
||||
62
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Add-requests-handler.mdx
vendored
Normal file
62
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Add-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: Добавить обработчик запросов и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Добавить обработчик запросов
|
||||
Добавляет новый обработчик в проект
|
||||
|
||||
|
||||
|
||||
`Функция ДобавитьОбработчикЗапросов(Знач Проект, Знач БиблиотекаОПИ, Знач ФункцияОПИ, Знач Метод = "GET") Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| БиблиотекаОПИ | --lib | Строка | ✔ | Имя библиотеки в CLI формате |
|
||||
| ФункцияОПИ | --func | Строка | ✔ | Имя функции Открытого пакета интеграций |
|
||||
| Метод | --method | Строка | ✖ | HTTP метод, который будет обрабатывать обработчик: GET, JSON, FORM |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат добавления обработчика
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ДобавитьОбработчикЗапросов \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--lib "telegram" \
|
||||
--func "ОтправитьТекстовоеСообщение" \
|
||||
--method "get"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ДобавитьОбработчикЗапросов ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--lib "telegram" ^
|
||||
--func "ОтправитьТекстовоеСообщение" ^
|
||||
--method "get"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true,
|
||||
"key": "fd758d8d2",
|
||||
"url_example": "localhost:port/fd758d8d2"
|
||||
}
|
||||
```
|
||||
58
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Delete-requests-handler.mdx
vendored
Normal file
58
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Delete-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: Удалить обработчик запросов и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Удалить обработчик запросов
|
||||
Удаляет обработчик запросов из проекта
|
||||
|
||||
|
||||
|
||||
`Функция УдалитьОбработчикЗапросов(Знач Проект, Знач КлючОбработчика) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат удаления
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh УдалитьОбработчикЗапросов \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\diujk5r0.pdy" \
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh УдалитьОбработчикЗапросов ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\diujk5r0.pdy" ^
|
||||
--handler "my-key"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true,
|
||||
"tables": {
|
||||
"handlers": true,
|
||||
"arguments": true
|
||||
}
|
||||
}
|
||||
```
|
||||
54
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Disable-requests-handler.mdx
vendored
Normal file
54
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Disable-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: Отключить обработчик запросов и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Отключить обработчик запросов
|
||||
Отключает обработчик по ключу
|
||||
|
||||
|
||||
|
||||
`Функция ОтключитьОбработчикЗапросов(Знач Проект, Знач КлючОбработчика) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат переключения
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ОтключитьОбработчикЗапросов \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--handler "713bc7899"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ОтключитьОбработчикЗапросов ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--handler "713bc7899"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
54
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Enable-requests-handler.mdx
vendored
Normal file
54
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Enable-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: Включить обработчик запросов и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Включить обработчик запросов
|
||||
Включает обработчик по ключу
|
||||
|
||||
|
||||
|
||||
`Функция ВключитьОбработчикЗапросов(Знач Проект, Знач КлючОбработчика) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат переключения
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ВключитьОбработчикЗапросов \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--handler "713bc7899"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ВключитьОбработчикЗапросов ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--handler "713bc7899"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
62
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Get-requests-handler.mdx
vendored
Normal file
62
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Get-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: Получить обработчик запросов и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Получить обработчик запросов
|
||||
Получает информацию об обработчике по ключу
|
||||
|
||||
|
||||
|
||||
`Функция ПолучитьОбработчикЗапросов(Знач Проект, Знач КлючОбработчика) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Информация об обработчике
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ПолучитьОбработчикЗапросов \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--handler "713bc7899"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ПолучитьОбработчикЗапросов ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--handler "713bc7899"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"data": {
|
||||
"active": 1,
|
||||
"function": "ОтправитьТекстовоеСообщение",
|
||||
"key": "5f937c77f",
|
||||
"library": "telegram",
|
||||
"method": "GET",
|
||||
"args": []
|
||||
},
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
60
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Get-requests-handlers-list.mdx
vendored
Normal file
60
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Get-requests-handlers-list.mdx
vendored
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: Получить список обработчиков запросов и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Получить список обработчиков запросов
|
||||
Получает список обработчиков в проекте
|
||||
|
||||
|
||||
|
||||
`Функция ПолучитьСписокОбработчиковЗапросов(Знач Проект) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Список обработчиков
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ПолучитьСписокОбработчиковЗапросов \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ПолучитьСписокОбработчиковЗапросов ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"active": 1,
|
||||
"function": "ОтправитьТекстовоеСообщение",
|
||||
"key": "fd758d8d2",
|
||||
"library": "telegram",
|
||||
"method": "GET"
|
||||
}
|
||||
],
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
65
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Update-handlers-key.mdx
vendored
Normal file
65
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Update-handlers-key.mdx
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
description: Обновить ключ обработчика и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Обновить ключ обработчика
|
||||
Заменяет ключ обработчика на новый
|
||||
|
||||
|
||||
|
||||
`Функция ОбновитьКлючОбработчика(Знач Проект, Знач КлючОбработчика, Знач НовыйКлюч = "") Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
| НовыйКлюч | --key | Строка | ✖ | Свой ключ, если необходимо. Новый стандартный UUID по умолчанию |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Информация об обработчике
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ОбновитьКлючОбработчика \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--handler "a8c6d2d38" \
|
||||
--key "***"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ОбновитьКлючОбработчика ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--handler "a8c6d2d38" ^
|
||||
--key "***"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"data": {
|
||||
"active": 1,
|
||||
"function": "СоздатьПост",
|
||||
"key": "98cf8b49a",
|
||||
"library": "vk",
|
||||
"method": "FORM",
|
||||
"args": []
|
||||
},
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
63
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Update-requests-handler.mdx
vendored
Normal file
63
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/Update-requests-handler.mdx
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: Изменить обработчик запросов и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Изменить обработчик запросов
|
||||
Изменяет значения полей обработчика запросов
|
||||
|
||||
|
||||
|
||||
`Функция ИзменитьОбработчикЗапросов(Знач Проект, Знач КлючОбработчика, Знач БиблиотекаОПИ = "", Знач ФункцияОПИ = "", Знач Метод = "") Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| КлючОбработчика | --handler | Строка | ✔ | Ключ обработчика |
|
||||
| БиблиотекаОПИ | --lib | Строка | ✖ | Имя библиотеки в CLI формате |
|
||||
| ФункцияОПИ | --func | Строка | ✖ | Имя функции Открытого пакета интеграций |
|
||||
| Метод | --method | Строка | ✖ | HTTP метод, который будет обрабатывать обработчик: GET, JSON, FORM |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат изменения обработчика
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ИзменитьОбработчикЗапросов \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--handler "713bc7899" \
|
||||
--lib "vk" \
|
||||
--func "СоздатьПост" \
|
||||
--method "FORM"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ИзменитьОбработчикЗапросов ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--handler "713bc7899" ^
|
||||
--lib "vk" ^
|
||||
--func "СоздатьПост" ^
|
||||
--method "FORM"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
4
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/_category_.json
vendored
Normal file
4
docs/ru/md/Addons/Melezh/Console-Interface/Handlers-configuration/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Настройка обработчиков",
|
||||
"position": "3"
|
||||
}
|
||||
53
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Create-project.mdx
vendored
Normal file
53
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Create-project.mdx
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: Создать проект и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Создать проект
|
||||
Создает файл проекта по выбранному пути
|
||||
|
||||
|
||||
|
||||
`Функция СоздатьПроект(Знач Путь) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Путь | --path | Строка | ✔ | Путь к файлу проекта |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат создания
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh СоздатьПроект \
|
||||
--path "C:\Users\bayselonarrend\AppData\Local\Temp\ikacftkh.cnv"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh СоздатьПроект ^
|
||||
--path "C:\Users\bayselonarrend\AppData\Local\Temp\ikacftkh.cnv"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true,
|
||||
"message": "Файл проекта успешно создан!",
|
||||
"path": "C:\\Users\\bayselonarrend\\AppData\\Local\\Temp\\zw443uvy.0xx"
|
||||
}
|
||||
```
|
||||
58
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Fill-project-settings.mdx
vendored
Normal file
58
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Fill-project-settings.mdx
vendored
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: Заполнить настройки проекта и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Заполнить настройки проекта
|
||||
Заполняет настройки из переданной коллекции
|
||||
|
||||
|
||||
|
||||
`Функция ЗаполнитьНастройкиПроекта(Знач Проект, Знач Настройки) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| Настройки | --set | Соответствие Из КлючИЗначение | ✔ | Коллекция ключ и значение для заполнения настроек |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Список настроек проекта
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
# JSON данные также могут быть переданы как путь к файлу .json
|
||||
|
||||
melezh ЗаполнитьНастройкиПроекта \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--set "{'logs_req_headers':false,'logs_req_body':false}"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
:: JSON данные также могут быть переданы как путь к файлу .json
|
||||
|
||||
melezh ЗаполнитьНастройкиПроекта ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--set "{'logs_req_headers':false,'logs_req_body':false}"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
88
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Get-project-settings.mdx
vendored
Normal file
88
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Get-project-settings.mdx
vendored
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: Получить настройки проекта и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Получить настройки проекта
|
||||
Получает список всех текущих настроек проекта
|
||||
|
||||
|
||||
|
||||
`Функция ПолучитьНастройкиПроекта(Знач Проект) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Список настроек проекта
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh ПолучитьНастройкиПроекта \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh ПолучитьНастройкиПроекта ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"description": "Пароль входа веб-консоли",
|
||||
"name": "ui_password",
|
||||
"value": "admin"
|
||||
},
|
||||
{
|
||||
"description": "Путь сохранения логов. Для отключения логирования установите пустое значение",
|
||||
"name": "logs_path",
|
||||
"value": "C:/Users/bayselonarrend/AppData/Local/Temp/Melezh/1dd360e7-2c1c-4d65-9b19-626257c88520"
|
||||
},
|
||||
{
|
||||
"description": "Логирование заголовков входящих запросов",
|
||||
"name": "logs_req_headers",
|
||||
"value": "true"
|
||||
},
|
||||
{
|
||||
"description": "Логирование тела входящих запросов",
|
||||
"name": "logs_req_body",
|
||||
"value": "true"
|
||||
},
|
||||
{
|
||||
"description": "Отключение логирования logs_req_body для запросов, свыше этого размер (в байтах). 0 - без ограничений",
|
||||
"name": "logs_req_max_size",
|
||||
"value": "104857600"
|
||||
},
|
||||
{
|
||||
"description": "Логирование тела исходящих ответов",
|
||||
"name": "logs_res_body",
|
||||
"value": "true"
|
||||
},
|
||||
{
|
||||
"description": "Отключение логирования logs_res_body для запросов, свыше этого размер (в байтах). 0 - без ограничений",
|
||||
"name": "logs_res_max_size",
|
||||
"value": "104857600"
|
||||
}
|
||||
],
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
32
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Run-project.mdx
vendored
Normal file
32
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Run-project.mdx
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: Запустить проект и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Запустить проект
|
||||
Запускает прокси сервер интеграций
|
||||
|
||||
|
||||
|
||||
`Функция ЗапуститьПроект(Знач Порт, Знач Проект) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Порт | --port | Число | ✔ | Порт запуска сервера |
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат остановки сервера
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
57
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Set-project-setting.mdx
vendored
Normal file
57
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Set-project-setting.mdx
vendored
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: Установить настройку проекта и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Установить настройку проекта
|
||||
Устанавливает значение выбранной настройки проекта
|
||||
|
||||
|
||||
|
||||
`Функция УстановитьНастройкуПроекта(Знач Проект, Знач Настройка, Знач Значение) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| Настройка | --key | Строка | ✔ | Ключ настройки проекта |
|
||||
| Значение | --value | Строка | ✔ | Значение настройки проекта |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат установки
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh УстановитьНастройкуПроекта \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--key "***" \
|
||||
--value "yo"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh УстановитьНастройкуПроекта ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--key "***" ^
|
||||
--value "yo"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
54
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Update-ui-password.mdx
vendored
Normal file
54
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/Update-ui-password.mdx
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: Сменить пароль UI и другие функции для работы с Melezh в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Сменить пароль UI
|
||||
Изменяет пароль для входа в веб-консоль
|
||||
|
||||
|
||||
|
||||
`Функция СменитьПарольUI(Знач Проект, Знач Пароль) Экспорт`
|
||||
|
||||
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|
||||
|-|-|-|-|-|
|
||||
| Проект | --proj | Строка | ✔ | Путь к файлу проекта |
|
||||
| Пароль | --pass | Строка | ✔ | Новый пароль |
|
||||
|
||||
|
||||
Возвращаемое значение: Структура Из КлючИЗначение - Результат смены пароля
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="bash" label="Bash" default>
|
||||
```bash
|
||||
melezh СменитьПарольUI \
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" \
|
||||
--pass "***"
|
||||
```
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="bat" label="CMD/Bat" default>
|
||||
```batch
|
||||
melezh СменитьПарольUI ^
|
||||
--proj "C:\Users\bayselonarrend\AppData\Local\Temp\osb5ekwx.44f" ^
|
||||
--pass "***"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
4
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/_category_.json
vendored
Normal file
4
docs/ru/md/Addons/Melezh/Console-Interface/Projects-setup/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Настройка проектов",
|
||||
"position": "2"
|
||||
}
|
||||
62
docs/ru/md/Addons/Melezh/Overview.mdx
vendored
Normal file
62
docs/ru/md/Addons/Melezh/Overview.mdx
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: Overview
|
||||
sidebar_class_name: Info
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, HTTP, Melezh]
|
||||
---
|
||||
|
||||
# Добро пожаловать!
|
||||
|
||||

|
||||
|
||||
**Melezh** - это серверная версия Открытого пакета интеграций, предоставляющая единый настраиваемый HTTP API для доступа к любым его библиотекам с возможностью установки значений по умолчанию, веб-консолью и встроенным логированием входящих запросов
|
||||
|
||||
## Принцип работы
|
||||
|
||||
Данный сервер устанавливается поверх `oint` - консольного приложения [Открытого пакета интеграций](https://github.com/Bayselonarrend/OpenIntegrations), и позволяет удаленно вызывать его методы по средством HTTP-запросов из любого места так, как это происходило бы в консоли на локальной машине. Melezh использует встроенный в OneScript сервер Kestrel для приема HTTP запросов, а затем интерпретирует их в команды `oint` для дальнейшего выполнения
|
||||
|
||||
Решение имеет гибкую систему настроек, позволяющую определить ограничения списка доступных команд и методов, а также установить значения параметров для выполнения команд по умолчанию. Это позволяет как просто уменьшить количество передаваемых данных, так и скрыть чувствительные данные от клиентской стороны в случае необходимости
|
||||
|
||||
|
||||
## Пример начальной настройки
|
||||
|
||||
В этом примере создается новый файл проекта с настройкой обработкичка GET-запросов для функции `ОтправитьТекстовоеСообщение` из библиотеки работы с Telegram. Также в нем устанавливается значение по умолчанию для параметра `token` без возможности перезаписи ("строгий")
|
||||
|
||||
```powershell
|
||||
|
||||
melezh СоздатьПроект --path R:\test_proj.melezh
|
||||
melezh ДобавитьОбработчикЗапросов --proj R:\test_proj.melezh --lib telegram --func ОтправитьТекстовоеСообщение --method GET
|
||||
melezh УстановитьАргументОбработчика --proj R:\test_proj.melezh --handler 42281f11b --arg token --value "***" --strict true
|
||||
melezh ЗапуститьПроект --proj R:\test_proj.melezh --port 7788
|
||||
|
||||
```
|
||||
|
||||
Обработчик будет доступен на `localhost:7788/42281f11b`, где `42281f11b` - идентификатор, получаемый при вызове `ДобавитьОбработчикЗапросов`, являясь одновременно и ключем обработчика для настройки, и URL эндпоинтом для обращений
|
||||
|
||||
Пример запроса для отправки текстового сообщения:
|
||||
|
||||
```url
|
||||
http://localhost:7788/42281f11b?chat=123123123&text="Hello world!"
|
||||
```
|
||||
|
||||
Как вы могли заметить, мы не передаем токен, так как он установлен по умолчанию
|
||||
|
||||
## Web UI
|
||||
|
||||
Кроме CLI интерфейса, для более простой интерактивной настройки и управления, можно использовать встроенную в Melezh веб-консоль:
|
||||
|
||||

|
||||
|
||||
*На записи: вход в консоль, добавление нового обработчика для создания новости в Bitrix24 с указанием двух параметров по умолчанию, отключение двух обработчиков, просмотр подробностей одного из последних событий, просмотр всех логов по одному из обработчиков за сегодня*
|
||||
|
||||
<br/>
|
||||
|
||||
**Веб-консоль позволяет:**
|
||||
- Следить за последними событиями сервера
|
||||
- Добавлять, изменять и удалять обработчики, менять состав параметров по умолчанию
|
||||
- Включать и отключать обработчики на время
|
||||
- Просматривать подробные логи по каждому обработанному запросу
|
||||
- Изменять настройки сервера
|
||||
|
||||
Если вы только начинаете работу с Melezh, то рекомендуется начать именно с этого режима. Получить доступ к веб-консоли можно по адресу `localhost:<ваш порт>/ui` после создания и запуска проекта
|
||||
|
||||
|
||||
44
docs/ru/md/Addons/Melezh/Start/First-start.mdx
vendored
Normal file
44
docs/ru/md/Addons/Melezh/Start/First-start.mdx
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
id: First-start
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
title: Первый запуск и создание проекта
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
В этом разделе описан запуск и первые шаги после установки Melezh на устройстве
|
||||
|
||||
## Запуск
|
||||
|
||||
Вне зависимости от операционной системы и способа установки, после ее завршения, Melezh должен быть доступен в терминале (командной строке) по команде `melezh`.
|
||||
|
||||
|
||||
>На Windows может потребоваться перезагрузка, но также там присутствует возможность прямого запуска по ярлыку в меню "Пуск"
|
||||
|
||||
|
||||
После вызова, будет показан начальный экран `melezh`:
|
||||
|
||||

|
||||
|
||||
Вы можете получить список всех доступных методов Melezh, вызвавв команду `melezh --help`. Вызов любого метода Melezh без параметров возвращает справку о его назначении и наборе аргументов:
|
||||
|
||||

|
||||
|
||||
## Создание проекта
|
||||
|
||||
Для полноценного начала работы с Melezh необходимо создать **проект** - файл, в котором будут хранится основные настройки и данные об обработчиках. Для этого необходимо вызывать команду `СоздатьПроект` и указать путь в аргументе `--path`
|
||||
|
||||

|
||||
|
||||
<hr/>
|
||||
|
||||
## Настройка проекта
|
||||
|
||||
Дальнейшая настройка проекта может осуществляться двумя способами:
|
||||
|
||||
+ **В консольном варианте** <br/>
|
||||
Настройка проекта может осуществляться дальнейшим вызовом команд `melezh` в терминале (командной строке). Список доступных команд и их аргументы перечислены в разделе *Консольный интерфейс*
|
||||
|
||||
+ **В веб-панели управления** <br/>
|
||||
Кроме консольного интерфейса, Melezh имеет встроенный Web UI, позволяющий упралвять проектом в интерактивном режиме. Подробнее о работе через веб-интерфейс можно узнать в разделе *Web-интерфейс*
|
||||
|
||||
|
||||
45
docs/ru/md/Addons/Melezh/Start/Installation.mdx
vendored
Normal file
45
docs/ru/md/Addons/Melezh/Start/Installation.mdx
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: Installation
|
||||
keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI]
|
||||
title: Установка
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
Для начала работы с Melezh необходимо пройти процедуру его установки, после чего создать и настроить проект. В этом разделе описан процесс установки Melezh на конкретном устройстве. Выбор того или иного способа зависит от операционной системы и наличия в ней OneScript с пакетным менеджером OPM:
|
||||
|
||||
## Windows
|
||||
|
||||
Установка Melezh на Windows осуществляется в процессе установки `oint` - основного консольного приложения Открытого пакета интеграций. Достаточно скачать установщики `oint` из релиза репозитория [OpenIntegrations](https://github.com/Bayselonarrend/OpenIntegrations) (v >= 1.24.0), после чего, в процессе установки, поставить флажок на странице с вопросом о дополнительной установке Melezh:
|
||||
|
||||

|
||||
|
||||
<hr/>
|
||||
|
||||
## Linux
|
||||
|
||||
Для установки Melezh на устройствах с ОС Linux, в релизах репозитория Melezh присутствуют `.deb` и `.rpm` пакеты. Оба они зависят от пакета `oint`, который в соответствующих вариантах можно найти в релизах репозитория [OpenIntegrations](https://github.com/Bayselonarrend/OpenIntegrations)
|
||||
|
||||
:::warning
|
||||
Melezh совместим с любой версией `oint`, выше 1.24.0, но при условии совпадения языков: и Melezh, и OInt поставляются в двух языковых вариантах - русском и английском, которые нельзя смешивать друг с другом. Т.е. русская версия Melezh может быть установлена только поверх русской версии OInt, а английская - только поверх английской, соответственно
|
||||
:::
|
||||
|
||||
<br/><hr/>
|
||||
|
||||
## OneScript
|
||||
|
||||
Melezh и OInt - это, в первую очередь, пакеты для [OneScript](https://github.com/EvilBeaver/OneScript), которые могут быть установлены при помощи пакетного менеджера OPM. Русская версия пакета может быть установлена из облачного хаба пакетов при помощи консольной команды:
|
||||
|
||||
```powershell
|
||||
opm install melezh
|
||||
```
|
||||
|
||||
В этом пакете уже прописаны зависимости от OInt - он будет установлен автоматически
|
||||
|
||||
Помимо этого, и английская, и русская версии могут быть установлены из `.ospx` файлов пакетов, которые находятся в релизах соответствующих репозиториев [Melezh](https://github.com/Bayselonarrend/OpenIntegrations) и [OpenIntegrations](https://github.com/Bayselonarrend/OpenIntegrations):
|
||||
|
||||
```powershell
|
||||
opm install -f oint.ospx
|
||||
opm install -f melezh.ospx
|
||||
```
|
||||
|
||||
Как и в случае с пакетами для Linux, важно соблюдать соответствие языков версий: русская версия Melezh может работать только в зависимости от русской версии OInt, а английская - в зависимости от английской
|
||||
16098
service/dictionaries/en.json
vendored
16098
service/dictionaries/en.json
vendored
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user