1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-08-24 19:49:22 +02:00

Доработка документации

This commit is contained in:
Anton Titovets
2025-03-17 10:30:34 +03:00
parent 28614fe336
commit e997749422
51 changed files with 107 additions and 989 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 991 B

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

@@ -9,7 +9,20 @@ sidebar_class_name: RCON
This section is dedicated to the library for working with the RCON. On this page, all the steps necessary to start working are described
## About implemented methods
## About the library
RCON (Remote Console) is a protocol used to remotely control servers, most commonly game servers. It allows administrators or owners to execute commands on a server from the outside, without having to physically access the machine where the server is running.
Typically, control via RCON is available on servers for games such as:
- Minecraft
- Counter Strike
- ARK
- Rust
- SAMP
- MTA
- etc.
This library provides two main functions for operation: `CreateConnection` for connection and authorisation on the server, and `ExecuteCommand` for performing actions. It is also possible to execute single commands without creating a preliminary connection, passing connection parameters to the `ExecuteCommand` method (in this case the connection will be opened and closed within the function, the only option for CLI version).
## Compatibility

View File

@@ -37,6 +37,7 @@ Fast navigation:
<a href="/docs/Instructions/Dropbox/"><img src={require('../../static/img/APIs/Dropbox.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Neocities/"><img src={require('../../static/img/APIs/Neocities.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/TCP/"><img src={require('../../static/img/APIs/TCP.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/RCON/"><img src={require('../../static/img/APIs/RCON.png').default} width="32" class="wp_logo"/></a>
</div>

View File

@@ -9,7 +9,20 @@ sidebar_class_name: RCON
Этот раздел посвящен библиотеке для работы с протоколом RCON. На данной странице описаны все действия, необходимые для полноценного начала работы
## О реализованных методах
## О библиотеке
RCON (Remote Console) — это протокол, используемый для удаленного управления серверами, чаще всего игровыми. Он позволяет администраторам или владельцам серверов выполнять команды на сервере извне, без необходимости физического доступа к машине, где запущен сервер.
Как правило, управление через RCON доступно на серверах для таких игр как:
- Minecraft
- Counter Strike
- ARK
- Rust
- SAMP
- MTA
- и пр.
Данная бибилотека предоставляет две основные функции для работы: `ОткрытьСоединение` для подключения и авторизации на сервере, и `ВыполнитьКоманду` для непосредственного выполнения действий. Также доступно выполнение одиночных команд без создания предварительного подключения, с передачей параметров подключения в метод `ВыполнитьКоманду` (в этом случае соединение будет открыто и закрыто в рамках, единственный вариант для CLI версии)
## Совместимость

View File

@@ -37,6 +37,7 @@ sidebar_class_name: NachaloRaboty
<a href="/docs/Instructions/Dropbox/"><img src={require('../../static/img/APIs/Dropbox.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/Neocities/"><img src={require('../../static/img/APIs/Neocities.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/TCP/"><img src={require('../../static/img/APIs/TCP.png').default} width="32" class="wp_logo"/></a>
<a href="/docs/Instructions/RCON/"><img src={require('../../static/img/APIs/RCON.png').default} width="32" class="wp_logo"/></a>
</div>
<br/>

View File

@@ -1,3 +0,0 @@
 {
"addParticipant": true
}

View File

@@ -1,3 +0,0 @@
 {
"updateGroupName": true
}

View File

@@ -1,3 +0,0 @@
 {
"removeParticipant": true
}

View File

@@ -1,4 +0,0 @@
 {
"setGroupAdmin": true,
"error": "participant not found"
}

View File

@@ -1,3 +0,0 @@
 {
"removeAdmin": true
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE5B81E635DFDE3"
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE5024A1D098D6E"
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE50E378A546C3C"
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE55557D3F44ED3"
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE58407F13F0861"
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE596B9A4F54772"
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE52B576D07D8D7"
}

View File

@@ -1,6 +0,0 @@
 {
"statusCode": 400,
"timestamp": "2025-03-06T21:29:27.603Z",
"path": "/waInstance7105187566/sendMessage/425010d90e114aa6b78f0969e1e67ec62579d30401c84d5183",
"message": "Validation failed. Details: 'chatId' is required"
}

View File

@@ -1,4 +0,0 @@
 {
"idMessage": "BAE5E7DBBF5C28B1",
"urlFile": "https://do-mediaout-7105.fra1.digitaloceanspaces.com/7105187566/b3158c13-bbeb-438d-8430-07455d4e60d2.mp4"
}

View File

@@ -1,4 +0,0 @@
 {
"idMessage": "BAE54873D5532888",
"urlFile": "https://do-mediaout-7105.fra1.digitaloceanspaces.com/7105187566/e34c3504-3c81-4934-a0b4-9f35da50c83e.jpg"
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE5D11C7B8D8651"
}

View File

@@ -1,3 +0,0 @@
 {
"idMessage": "BAE51C21F1772019"
}

View File

@@ -1,3 +0,0 @@
 {
"isCleared": true
}

View File

@@ -1,3 +0,0 @@
 {
"isReboot": true
}

View File

@@ -1,5 +0,0 @@
 {
"messages": [
"BAE5B7B67D5074B0"
]
}

View File

@@ -1,3 +0,0 @@
 {
"removeAdmin": true
}

File diff suppressed because one or more lines are too long

View File

@@ -1,16 +0,0 @@
 {
"groupId": "120363409017641455@g.us",
"owner": "***",
"subject": "New group",
"creation": 1741296537,
"participants": [
{
"id": "***",
"isAdmin": true,
"isSuperAdmin": true
}
],
"subjectTime": null,
"groupInviteLink": "https://chat.whatsapp.com/KpPMed1h5MQGiezrvGkdUg",
"isMessageAllowed": true
}

View File

@@ -1,6 +0,0 @@
 {
"avatar": "https://pps.whatsapp.net/v/t61.24694-24/473400535_1640834266806989_5305587157797475890_n.jpg?stp=dst-jpg_s96x96_tt6&ccb=11-4&oh=01_Q5AaIIel2AVOTn8obQmqXcEmwwe1m_hSPGocdFB1TXwjZPr4&oe=67D09C63&_nc_sid=5e03e0&_nc_cat=109",
"phone": "***",
"stateInstance": "authorized",
"deviceId": "***"
}

View File

@@ -1,26 +0,0 @@
 {
"wid": "375447830891@c.us",
"countryInstance": "",
"typeAccount": "",
"webhookUrl": "",
"webhookUrlToken": "",
"delaySendMessagesMilliseconds": 0,
"markIncomingMessagesReaded": "no",
"markIncomingMessagesReadedOnReply": "no",
"sharedSession": "no",
"proxyInstance": "system proxy",
"outgoingWebhook": "no",
"outgoingMessageWebhook": "no",
"outgoingAPIMessageWebhook": "no",
"incomingWebhook": "no",
"deviceWebhook": "no",
"statusInstanceWebhook": "no",
"stateWebhook": "no",
"enableMessagesHistory": "no",
"keepOnlineStatus": "no",
"pollMessageWebhook": "yes",
"incomingBlockWebhook": "no",
"incomingCallWebhook": "no",
"editedMessageWebhook": "yes",
"deletedMessageWebhook": "yes"
}

View File

@@ -1,7 +0,0 @@
 {
"phoneContact": 79001234568,
"firstName": "Артем",
"middleName": "Евпаторийский",
"lastName": "Петрович",
"company": "Велосипед"
}

View File

@@ -1,6 +0,0 @@
 {
"latitude": 53.908522,
"longitude": 27.574821,
"address": "Площадь Победы, Минск",
"nameLocation": "пл. Победы"
}

View File

@@ -1,23 +0,0 @@
 {
"type": "outgoing",
"idMessage": "BAE504BCE50C4EE9",
"timestamp": 1742152330,
"typeMessage": "extendedTextMessage",
"chatId": "120363410406221140@g.us",
"textMessage": "Новое сообщение",
"extendedTextMessage": {
"text": "Новое сообщение",
"description": "",
"title": "",
"previewType": "None",
"jpegThumbnail": "",
"forwardingScore": 0,
"isForwarded": false
},
"statusMessage": "",
"sendByApi": true,
"deletedMessageId": "",
"editedMessageId": "",
"isEdited": false,
"isDeleted": false
}

View File

@@ -1,3 +0,0 @@
 {
"stateInstance": "authorized"
}

View File

@@ -1,19 +0,0 @@
 {
"webhookUrl": "",
"webhookUrlToken": "",
"delaySendMessagesMilliseconds": "",
"markIncomingMessagesReaded": "",
"markIncomingMessagesReadedOnReply": "",
"outgoingWebhook": "",
"outgoingMessageWebhook": "",
"outgoingAPIMessageWebhook": "",
"stateWebhook": "",
"incomingWebhook": "",
"deviceWebhook": "",
"keepOnlineStatus": "",
"pollMessageWebhook": "",
"incomingBlockWebhook": "",
"incomingCallWebhook": "",
"editedMessageWebhook": "",
"deletedMessageWebhook": ""
}

View File

@@ -1,19 +0,0 @@
 {
"webhookUrl": "<URL для отправки уведомлений>",
"webhookUrlToken": "<токен для доступа к вашему серверу уведомлений, если требуется>",
"delaySendMessagesMilliseconds": "<интервал отправки сообщений в миллисекундах>",
"markIncomingMessagesReaded": "<отмечать входящие сообщения прочитанными: yes, no>",
"markIncomingMessagesReadedOnReply": "<отмечать входящие сообщения прочитанными при отправке сообщения в чат: yes, no>",
"outgoingWebhook": "<получать уведомления о статусах отправки/доставки/прочтении исходящих сообщений: yes, no>",
"outgoingMessageWebhook": "<получать уведомления о сообщениях, отправленных с телефона: yes, no>",
"outgoingAPIMessageWebhook": "<получать уведомления о сообщениях, отправленных через API: yes, no>",
"stateWebhook": "<получать уведомления об изменении состояния авторизации инстанса: yes, no>",
"incomingWebhook": "<получать уведомления о входящих сообщениях и файлах: yes, no>",
"deviceWebhook": "<получать уведомления об устройстве (телефоне) и уровне заряда батареи: yes, no>",
"keepOnlineStatus": "<выставляет статус 'В сети' для вашего аккаунта>",
"pollMessageWebhook": "<получать уведомления о создании опроса и голосовании в опросе: yes, no>",
"incomingBlockWebhook": "<получать уведомления о добавлении чата в список заблокированных контактов: yes, no>",
"incomingCallWebhook": "<получать уведомления о статусах входящего звонка: yes, no>",
"editedMessageWebhook": "<получать уведомления о факте того, что сообщение было отредактировано: yes, no>",
"deletedMessageWebhook": "<получать уведомления о факте того, что сообщение было удалено: yes, no>"
}

File diff suppressed because one or more lines are too long

View File

@@ -1,3 +0,0 @@
 {
"downloadUrl": "https://sw-media.storage.yandexcloud.net/7105187566/9e0eedb5-caab-498d-bcc7-c79e23b9abbe.jpeg"
}

View File

@@ -1 +0,0 @@
 "instance is starting or not authorized"

View File

@@ -1,6 +0,0 @@
 {
"apiUrl": "https://7105.api.greenapi.com",
"mediaUrl": "https://7105.media.greenapi.com",
"idInstance": "7105187566",
"apiTokenInstance": "***"
}

View File

@@ -1,4 +0,0 @@
 {
"result": true,
"reason": ""
}

View File

@@ -1,5 +0,0 @@
 {
"reason": null,
"urlAvatar": null,
"setGroupPicture": true
}

View File

@@ -1,5 +0,0 @@
 {
"reason": null,
"urlAvatar": "https://pps.whatsapp.net/v/t61.24694-24/473397097_589119524121376_3590966257766927896_n.jpg?ccb=11-4&oh=01_Q5AaIBA3ssebyv9WxR_ZbcPX-10atEaxoMqHEQj1OOADmaKv&oe=67D092A2&_nc_sid=5e03e0&_nc_cat=110",
"setProfilePicture": true
}

View File

@@ -1,3 +0,0 @@
 {
"saveSettings": false
}

View File

@@ -1,3 +0,0 @@
 {
"setRead": true
}

BIN
media/RCON.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 4.6 KiB

View File

@@ -2394,6 +2394,7 @@
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_MediaURL" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_IdInstance", ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_Token" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_AccountID" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("Picture" , ПараметрыТеста);
GreenAPI_СформироватьПараметрыДоступа(ПараметрыТеста);
@@ -2417,6 +2418,7 @@
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_MediaURL" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_IdInstance", ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_Token" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_AccountID" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("Picture" , ПараметрыТеста);
GreenAPI_СоздатьГруппу(ПараметрыТеста);
@@ -2439,6 +2441,7 @@
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_IdInstance" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_Token" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_TestGroupID", ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_AccountID" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("Picture" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("Video" , ПараметрыТеста);
@@ -2480,6 +2483,7 @@
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_MediaURL" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_IdInstance" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_Token" , ПараметрыТеста);
OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию("GreenAPI_AccountID" , ПараметрыТеста);
GreenAPI_ПолучитьОчередьСообщений(ПараметрыТеста);
GreenAPI_ОчиститьОчередьСообщений(ПараметрыТеста);
@@ -2517,6 +2521,7 @@
RCON_СформироватьПараметрыСоединения(ПараметрыТеста);
RCON_ОткрытьСоединение(ПараметрыТеста);
RCON_ВыполнитьКоманду(ПараметрыТеста);
RCON_ЭтоКоннектор(ПараметрыТеста);
КонецПроцедуры
@@ -18460,6 +18465,15 @@
// END
Попытка
JSON = OPI_Инструменты.JSONСтрокой(Результат);
JSON = СтрЗаменить(JSON, ПараметрыФункции["GreenAPI_AccountID"], "1234567890@c.us");
Результат = OPI_Инструменты.JsonВСтруктуру(JSON, Истина);
Исключение
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "Ошибка JSON");
КонецПопытки;
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "ПолучитьНастройкиИнстанса", "GreenAPI");
OPI_ПолучениеДанныхТестов.Проверка_ГринИнстанс(Результат);
@@ -19125,8 +19139,14 @@
// END
JSON = OPI_Инструменты.JSONСтрокой(Результат);
JSON = СтрЗаменить(JSON, ПараметрыФункции["GreenAPI_AccountID"], "1234567890@c.us");
Попытка
JSON = OPI_Инструменты.JSONСтрокой(Результат);
JSON = СтрЗаменить(JSON, ПараметрыФункции["GreenAPI_AccountID"], "1234567890@c.us");
Результат = OPI_Инструменты.JsonВСтруктуру(JSON, Истина);
Исключение
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "Ошибка JSON");
КонецПопытки;
Результат = OPI_Инструменты.JsonВСтруктуру(JSON, Истина);
@@ -19246,12 +19266,16 @@
// END
JSON = OPI_Инструменты.JSONСтрокой(Результат);
JSON = СтрЗаменить(JSON, ПараметрыФункции["GreenAPI_AccountID"], "1234567890@c.us");
Попытка
JSON = OPI_Инструменты.JSONСтрокой(Результат);
JSON = СтрЗаменить(JSON, ПараметрыФункции["GreenAPI_AccountID"], "1234567890@c.us");
Результат = OPI_Инструменты.JsonВСтруктуру(JSON, Истина);
Результат = OPI_Инструменты.JsonВСтруктуру(JSON, Истина);
Исключение
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "Ошибка JSON");
КонецПопытки;
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "СформироватьПараметрыДоступа", "GreenAPI");
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "ПолучитьИсториюЧата", "GreenAPI");
OPI_ПолучениеДанныхТестов.Проверка_Массив(Результат);
КонецПроцедуры
@@ -19271,6 +19295,15 @@
// END
Попытка
JSON = OPI_Инструменты.JSONСтрокой(Результат);
JSON = СтрЗаменить(JSON, ПараметрыФункции["GreenAPI_AccountID"], "1234567890@c.us");
Результат = OPI_Инструменты.JsonВСтруктуру(JSON, Истина);
Исключение
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "Ошибка JSON");
КонецПопытки;
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "ПолучитьСообщение", "GreenAPI");
OPI_ПолучениеДанныхТестов.Проверка_ГринСообщение(Результат);
@@ -19288,6 +19321,15 @@
// END
Попытка
JSON = OPI_Инструменты.JSONСтрокой(Результат);
JSON = СтрЗаменить(JSON, ПараметрыФункции["GreenAPI_AccountID"], "1234567890@c.us");
Результат = OPI_Инструменты.JsonВСтруктуру(JSON, Истина);
Исключение
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "Ошибка JSON");
КонецПопытки;
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "ПолучитьЖурналВходящихСообщений", "GreenAPI");
OPI_ПолучениеДанныхТестов.Проверка_Массив(Результат);
@@ -19305,6 +19347,15 @@
// END
Попытка
JSON = OPI_Инструменты.JSONСтрокой(Результат);
JSON = СтрЗаменить(JSON, ПараметрыФункции["GreenAPI_AccountID"], "1234567890@c.us");
Результат = OPI_Инструменты.JsonВСтруктуру(JSON, Истина);
Исключение
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "Ошибка JSON");
КонецПопытки;
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "ПолучитьЖурналИсходящихСообщений", "GreenAPI");
OPI_ПолучениеДанныхТестов.Проверка_Массив(Результат);
@@ -19325,7 +19376,8 @@
// END
Результат["URL"] = "127.0.0.1:25565";
Результат["url"] = "127.0.0.1:25565";
Результат["password"] = "***";
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "СформироватьПараметрыСоединения", "RCON");
OPI_ПолучениеДанныхТестов.Проверка_Структура(Результат);
@@ -19374,6 +19426,24 @@
КонецПроцедуры
Процедура RCON_ЭтоКоннектор(ПараметрыФункции)
URL = ПараметрыФункции["RCON_URL"];
Пароль = ПараметрыФункции["RCON_Password"];
ТаймаутЗаписи = 20;
ТаймаутЧтения = 20;
ПараметрыСоединения = OPI_RCON.СформироватьПараметрыСоединения(URL, Пароль, ТаймаутЧтения, ТаймаутЗаписи);
Соединение = OPI_RCON.ОткрытьСоединение(ПараметрыСоединения);
Результат = OPI_RCON.ЭтоКоннектор(Соединение);
// END
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "ЭтоКоннектор", "RCON");
OPI_ПолучениеДанныхТестов.Проверка_Истина(Результат);
КонецПроцедуры
#КонецОбласти
#КонецОбласти