# API клиент бизнес-платформы IEK

## Содержание

- [Начало работы](#начало-работы)
- [Установка](#установка)
- [Использование](#использование)
- [Доступные методы](#доступные-методы)
- [Используемые инструменты](#используемые-инструменты)
- [Авторы](#авторы)
- [Лицензия](#лицензия)

## Начало работы

Эти инструкции помогут вам запустить копию проекта на вашем локальном компьютере для целей разработки и тестирования.



#### Установка Go

Убедитесь, что у вас установлена последняя версия Go. Инструкции по установке можно найти на официальном
сайте [Go](https://golang.org/doc/install).

Пример:

```sh
go version go1.23.1
```


### Установка

Пошаговая инструкция по созданию окружения.

1. Установите проект с помощью `go get`
   ```sh
   go get -u gitea.24example.ru/spavelit/bpiek
   ```
2. Установите зависимости
   ```sh
   go mod tidy
   ```

### Использование

Инструкции по использованию вашего проекта.

#### Запуск приложения

Пример:

```sh
go run main.go
```

#### Пример использования

Примечание:
Добавьте пример кода, чтобы пользователи могли быстро начать работу с вашим проектом.

```go
package main

import (
	"encoding/json"
	"fmt"
	bpiek "gitea.24example.ru/spavelit/bpiek/api"
)

func main() {
	credentials := bpiek.Credentials{
		Username: "mail@example.ru",
		Password: "password",
	}

	api := bpiek.NewApi(credentials)
	
	result, err := api.GetRemainsAndPlanresidues()
	if err != nil {
		panic(err)
	}

	b, _ := json.MarshalIndent(result[1], "", "  ")
	fmt.Print(string(b))
}
```

### Доступные методы

В данном разделе приведены основные методы, доступные в API клиенте для бизнес-платформы IEK:

1. `NewApi(credentials bpiek.Credentials)`
    - Создает новый экземпляр API клиента с предоставленными учетными данными.

2. `GetParentCategories() ([]model.Category, error)`
    - Возвращает массив категорий каталога 1-ого уровня.

3. `GetCategories() ([]model.Category, error)`
    - Возвращает массив с категориями.

4. `GetTreeCategories() ([]model.TreeCategories, error)`
    - Возвращает дерево категорий.

5. `GetProducts() ([]model.Product, error)`
    - Возвращает массив с продукцией.

6. `GetProductByArticle(article string) (model.Product, error)`
    - Возвращает товар по артикулу.

7. `GetRemainsAndPlanresidues() ([]model.ShortProduct, error)`
    - Возвращает массив, в котором содержатся актуальные цены
      и остатки товаров.


Эти методы могут использоваться для взаимодействия с бизнес-платформой IEK в рамках вашего проекта. Подробная
документация каждого метода доступна в исходниках или официальной документации БП IEK.


## Используемые инструменты

Список инструментов и библиотек, которые использовались при создании проекта.

* [GoLang](https://golang.org/) - Язык программирования.
* [Resty](https://github.com/go-resty/resty) - Simple HTTP and REST client library for Go.


## Авторы

* **Павел Синицин** - *Rosar-L* - [Gitea](https://gitea.24example.ru/spavelit/)

## Лицензия

Этот проект лицензирован под лицензией MIT - подробности смотрите в файле [LICENSE.md](LICENSE.md).