Pavel Sinitsin
8eac71e65c
Introduce initial README.md with project setup, usage instructions, and method documentation for the IEK business platform API client. Additionally, include the MIT license information in LICENSE.md. |
||
---|---|---|
api | ||
client | ||
model | ||
utils | ||
.gitignore | ||
go.mod | ||
go.sum | ||
LICENSE.md | ||
README.md |
API клиент бизнес-платформы IEK
Содержание
Начало работы
Эти инструкции помогут вам запустить копию проекта на вашем локальном компьютере для целей разработки и тестирования.
Установка Go
Убедитесь, что у вас установлена последняя версия Go. Инструкции по установке можно найти на официальном сайте Go.
Пример:
go version go1.23.1
Установка
Пошаговая инструкция по созданию окружения.
- Установите проект с помощью
go get
go get -u gitea.24example.ru/spavelit/bpiek
- Установите зависимости
go mod tidy
Использование
Инструкции по использованию вашего проекта.
Запуск приложения
Пример:
go run main.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:
-
NewApi(credentials bpiek.Credentials)
- Создает новый экземпляр API клиента с предоставленными учетными данными.
-
GetParentCategories() ([]model.Category, error)
- Возвращает массив категорий каталога 1-ого уровня.
-
GetCategories() ([]model.Category, error)
- Возвращает массив с категориями.
-
GetTreeCategories() ([]model.TreeCategories, error)
- Возвращает дерево категорий.
-
GetProducts() ([]model.Product, error)
- Возвращает массив с продукцией.
-
GetProductByArticle(article string) (model.Product, error)
- Возвращает товар по артикулу.
-
GetRemainsAndPlanresidues() ([]model.ShortProduct, error)
- Возвращает массив, в котором содержатся актуальные цены и остатки товаров.
Эти методы могут использоваться для взаимодействия с бизнес-платформой IEK в рамках вашего проекта. Подробная документация каждого метода доступна в исходниках или официальной документации БП IEK.
Используемые инструменты
Список инструментов и библиотек, которые использовались при создании проекта.
Авторы
- Павел Синицин - Rosar-L - Gitea
Лицензия
Этот проект лицензирован под лицензией MIT - подробности смотрите в файле LICENSE.md.