1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-11-21 17:56:56 +02:00

Начало документации S3

This commit is contained in:
Anton 2024-11-14 23:03:00 +03:00
parent afd178002d
commit c1c159e4dc
6 changed files with 107 additions and 1 deletions

BIN
Media/S3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 KiB

View File

@ -130,7 +130,7 @@ li > a.menu__link {
.Notion a::before, .GoogleCalendar a::before, .GoogleDrive a::before, .GoogleSheets a::before, .Notion a::before, .GoogleCalendar a::before, .GoogleDrive a::before, .GoogleSheets a::before,
.Slack a::before, .YandexDisk a::before, .Dropbox a::before, .Bitrix24 a::before, .Messenger a::before, .Slack a::before, .YandexDisk a::before, .Dropbox a::before, .Bitrix24 a::before, .Messenger a::before,
.Social a::before, .Database a::before, .Folder a::before, .Calendar a::before, .CRM a::before, .Commerce a::before, .Social a::before, .Database a::before, .Folder a::before, .Calendar a::before, .CRM a::before, .Commerce a::before,
.VKTeams a::before, .Ozon a::before, .Neocities a::before, .CDEK a::before, .Start a::before, .Other a::before{ .VKTeams a::before, .S3 a::before, .Ozon a::before, .Neocities a::before, .CDEK a::before, .Start a::before, .Other a::before{
padding-right: 0.7rem; padding-right: 0.7rem;
padding-top: 0.4rem; padding-top: 0.4rem;
} }
@ -203,6 +203,10 @@ li > a.menu__link {
content: url(../../static/img/APIs/small/CDEK.png); content: url(../../static/img/APIs/small/CDEK.png);
} }
.S3 > div > a::before{
content: url(../../static/img/APIs/small/S3.png);
}
.Messenger > div > a::before{ .Messenger > div > a::before{
content: url(../../static/img/Categories/chat.png); content: url(../../static/img/Categories/chat.png);
} }

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

@ -0,0 +1,51 @@
---
id: S3
sidebar_class_name: S3
---
<img src={require('../../static/img/APIs/S3.png').default} width='64px' />
# S3 (MinIO)
:::important
S3 - is a standard used by different software products. This means that the availability of methods, as well as their parameters, may differ depending on what software you are using. MinIO-based object storage is used to develop and test this library
:::
This section is dedicated to the library for working with AWS S3 API. On this page, all the steps necessary to start working are described
## Getting started
1. Obtain the following authorization data to work with S3:
+ Access key
+ Secret key
+ Region
+ Storage URL
+ Type of service (by default - S3)
2. Pass the received data to the `GetDataStructure` function and get the structure of the basic data
```bsl title="1С:Enterprise/OneScript"
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
```
```bash title="CLI"
oint s3 GetBasicDataStructure
--url "storage-155.s3hoster.by"
--access "BRN5RKJE67..."
--secret "NNhv+i9PrytpT8Tu0C1N..."
--region "BTC"
```
3. Use the resulting structure (or JSON) to call other methods of working with S3 API (`BasicData` parameter)

View File

@ -0,0 +1,51 @@
---
id: S3
sidebar_class_name: S3
---
<img src={require('../../static/img/APIs/S3.png').default} width='64px' />
# S3 (MinIO)
:::important
S3 - это стандарт, используемый различными программными продуктами. Это означает, что доступность методов, а также их параметры, могут отличаться в зависимости от того, какое ПО вы используете. Для разработки и тестирования данной библиотеки используется объектное хранилище на базе MinIO
:::
Этот раздел посвящен библиотеке для работы с AWS S3 API. На данной странице описаны все действия, необходимые для полноценного начала работы
## Начало работы
1. Получите следующие авторизационные данные для работы с S3:
+ Access key
+ Secret key
+ Region
+ URL сервера
+ Тип сервиса (по умолчанию - S3)
2. Полученные данные передайте в функцию `ПолучитьСтруктуруДанных` и получите структуру основных данных
```bsl title="1С:Предприятие/OneScript"
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
ОсновныеДанные = OPI_S3.ПолучитьСтруктуруДанных(URL, AccessKey, SecretKey, Region);
```
```bash title="CLI"
oint s3 ПолучитьСтруктуруДанных
--url "storage-155.s3hoster.by"
--access "BRN5RKJE67..."
--secret "NNhv+i9PrytpT8Tu0C1N..."
--region "BTC"
```
3. Используйте полученную структуру (или JSON) для вызова других методов работы с S3 API (параметр `ОсновныеДанные`)