diff --git a/Media/S3.png b/Media/S3.png new file mode 100644 index 0000000000..9e0f5d27c8 Binary files /dev/null and b/Media/S3.png differ diff --git a/docs/docusaurus/src/css/custom.css b/docs/docusaurus/src/css/custom.css index a4466cc66e..a45ab8feef 100644 --- a/docs/docusaurus/src/css/custom.css +++ b/docs/docusaurus/src/css/custom.css @@ -130,7 +130,7 @@ li > a.menu__link { .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, .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-top: 0.4rem; } @@ -203,6 +203,10 @@ li > a.menu__link { content: url(../../static/img/APIs/small/CDEK.png); } +.S3 > div > a::before{ + content: url(../../static/img/APIs/small/S3.png); +} + .Messenger > div > a::before{ content: url(../../static/img/Categories/chat.png); } diff --git a/docs/docusaurus/static/img/APIs/S3.png b/docs/docusaurus/static/img/APIs/S3.png new file mode 100644 index 0000000000..d73a6c8692 Binary files /dev/null and b/docs/docusaurus/static/img/APIs/S3.png differ diff --git a/docs/docusaurus/static/img/APIs/small/S3.png b/docs/docusaurus/static/img/APIs/small/S3.png new file mode 100644 index 0000000000..0f09257a78 Binary files /dev/null and b/docs/docusaurus/static/img/APIs/small/S3.png differ diff --git a/docs/en/md/Instructions/S3.md b/docs/en/md/Instructions/S3.md new file mode 100644 index 0000000000..28416570bb --- /dev/null +++ b/docs/en/md/Instructions/S3.md @@ -0,0 +1,51 @@ +--- +id: S3 +sidebar_class_name: S3 +--- + + + +# 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) diff --git a/docs/ru/md/Instructions/S3.md b/docs/ru/md/Instructions/S3.md new file mode 100644 index 0000000000..96317343cf --- /dev/null +++ b/docs/ru/md/Instructions/S3.md @@ -0,0 +1,51 @@ +--- +id: S3 +sidebar_class_name: S3 +--- + + + +# 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 (параметр `ОсновныеДанные`)