v1.2.0

2023-03-01 19:05:53 +03:00
parent de12bc2acc
commit 42800ac4fe
573 changed files with 2077 additions and 1844 deletions
--- a/README.md
+++ b/README.md
@@ -3,8 +3,10 @@
 Decort SDK - это библиотека, написанная на языке GO, позволяющая взаимодействовать с API облачной платформы **DECORT**. Библиотека содеражит в себе структуры и методы, необходимые для отправки запросов. Decort SDK имеет встроенный http-клиент и поддерживает разные способы авторизации на платформе. Библиотека так же содержит в себе модели ответов от платформы.

 ## Версии
-	- Версия 1.0.0 Decort-SDK соответствует 3.8.4 версии платформы 
-	- Версия 1.1.0 Decort-SDK соответствует 3.8.5 версии платформы 
+
+    - Версия 1.0.x Decort-SDK соответствует 3.8.4 версии платформы
+    - Версия 1.1.x Decort-SDK соответствует 3.8.5 версии платформы
+    - Версия 1.2.x Decort-SDK соответствует 3.8.5 версии платформы

 ## Оглавление

@@ -17,6 +19,11 @@ Decort SDK - это библиотека, написанная на языке G
  - [Создание клиента](#создание-клиента)
  - [Создание структуры запроса](#cоздание-структуры-запроса)
  - [Выполнение запроса](#выполнение-запроса)
+- [Работа с legacy клиентом](#работа-с-legacy-клиентом)
+  - [Настройка конфигурации legacy клиента](#настройка-конфигурации-legacy-клиента)
+  - [Создание legacy клиента](#создание-legacy-клиента)
+  - [Создание структуры запроса](#cоздание-структуры-запроса)
+  - [Выполнение запроса](#выполнение-запроса)

 ## Установка

@@ -429,3 +436,65 @@ func main() {
    fmt.Println(res)
 }
 ```
+
+## Работа с legacy клиентом
+
+Работа с legacy клиентом применяется для пользователей, которые не используют для авторизации decs3o.
+
+### Настройка конфигурации legacy клиента
+
+Сначала, необходимо создать переменную конфигурации клиента. Конфигурация состоит как из обязательных, так и необязательных полей.
+
+| Поле          | Тип    | Обязательный | Описание                                                           |
+| ------------- | ------ | ------------ | ------------------------------------------------------------------ |
+| Username      | string | Да           | username legacy пользователя                                       |
+| Password      | string | Да           | пароль legacy пользователя                                         |
+| DecortURL     | string | Да           | URL адрес платформы, с которой будет осуществляться взаимодействие |
+| Retries       | uint   | Нет          | Кол-во неудачных попыток выполнения запроса, по умолчанию - 5      |
+| SSLSkipVerify | bool   | Нет          | Пропуск проверки подлинности сертификата, по умолчанию - true      |
+| Token         | string | Нет          | JWT токен                                                          |
+
+Пример кода:
+
+```go
+import (
+    "github.com/rudecs/decort-sdk/config"
+)
+func main(){
+    // Настройка конфигурации
+    legacyCfg := config.LegacyConfig{
+        Username:     "<USERNAME>",
+        Password: "<PASSWORD>",
+        DecortURL: "https://mr4.digitalenergy.online",
+        Retries:   5,
+    }
+}
+```
+
+### Создание legacy клиента
+
+Создание клиента происходит с помощью функции-строителя `NewLegacy` из основного пакета `decort-sdk`, для избежания проблем с именами, пакету можно присвоить алиас `decort`. Функция принимает конфигурацию, возвращает структуру `DecortClient`, с помощью которой можно взаимодействовать с платформой.
+
+### Пример
+
+```go
+package main
+
+import (
+    "github.com/rudecs/decort-sdk/config"
+    decort "github.com/rudecs/decort-sdk"
+)
+
+func main() {
+    // Настройка конфигурации
+    legacyCfg := config.LegacyConfig{
+        Username:  "<USERNAME>",
+        Password:  "<PASSWORD>",
+        DecortURL: "https://mr4.digitalenergy.online",
+        Retries:   5,
+    }
+
+    // Создание клиента
+    legacyClient := decort.NewLegacy(cfg)
+}
+```