Warning
SDK находится в стадии разработки!
Некоторые методы могут отсутствовать или работать неправильно!
Подробная документация в процессе написания.
Требуемая версия go >= 1.21
go get -u github.com/arcsub/go-moysklad
Каждый запрос на создание/изменение/удаление возвращает 3 аргумента. Рассмотрим объявление функции
func (s *endpointCreate[T]) Create(ctx context.Context, entity *T, params ...*Params) (*T, *resty.Response, error)
В примере выше нас интересуют возвращаемые аргументы: (*T, *resty.Response, error)
*T
– указатель на сущность/документ, например *Product при вызовеCreate()
(возвращаетbool
при вызове методаDelete()
).*resty.Response
– ответ на запрос, содержащий *http.Response и некоторую другую информацию.error
– ошибки, если они были. При возникновении ошибок от API МойСклад в качестве ошибки будет заполненная структураApiErrors
Поля структур сущностей и документов являются указателями.
- Чтобы получить значение по указателю необходимо вызвать метод структуры
GetFieldName()
.FieldName
- наименование поля.
Например:
name := product.GetName()
id := product.GetID()
- Чтобы установить значение необходимо передать значение в соответствующий метод
SetFieldName(value)
FieldName
- наименование поляvalue
- передаваемое значение.
Note
Методы SetFieldName()
возвращают указатель на объект, что позволяет вызывать методы по цепочке.
Например:
product := new(moysklad.Product)
product.SetName("iPhone 15 Pro Max").SetCode("APPL15PM")
Для безопасного разыменовывания указателя необходимо передать указатель в методDeref()
Чтобы установить указатель на примитивное значение поля также существуют вспомогательные методы:Bool()
возвращает *boolInt()
возвращает *intUint()
возвращает *uint64Float()
возвращает *float64String()
возвращает *string
client := moysklad.NewClient()
httpClient := &http.Client{Timeout: 5 * time.Minute}
client := moysklad.NewHTTPClient(httpClient)
restyClient := resty.New()
client := moysklad.NewRestyClient(restyClient)
Имеется два способа аутентификации.
- С помощью токена. Метод клиента
WithTokenAuth()
client := moysklad.NewClient().WithTokenAuth(os.Getenv("MOYSKLAD_TOKEN"))
- С помощью пары логин/пароль. Метод клиента
WithBasicAuth()
client := moysklad.NewClient().WithBasicAuth(os.Getenv("MOYSKLAD_USERNAME"), os.Getenv("MOYSKLAD_PASSWORD"))
Установить необходимый таймаут для http клиента.
client := moysklad.NewClient().WithTimeout(5 * time.Minute)
Получить простой клиент с авторизацией через токен.
client := moysklad.NewClient().WithTokenAuth(os.Getenv("MOYSKLAD_TOKEN"))
Получить простой клиент с авторизацией через пару логин/пароль.
client := moysklad.NewClient().
WithBasicAuth(os.Getenv("MOYSKLAD_USERNAME"), os.Getenv("MOYSKLAD_PASSWORD"))
Временное отключение уведомлений вебхуков
// отключим уведомления вебхуков на данном клиенте
client := moysklad.NewClient().WithDisabledWebhookContent(true)
params := new(moysklad.Params)
Количество элементов на странице limit=val
Пример:
params.WithLimit(100)
Пример:
params.WithOffset(100)
Пример:
params.WithSearch("iPhone 15")
Пример:
params.WithExpand("positions").WithExpand("group")
Пример:
params.WithFilterEquals("name", "Яблоко")
Пример:
params.WithFilterGreater("sum", "100")
Пример:
params.WithFilterLesser("sum", "1000")
Пример:
params.WithFilterGreaterOrEquals("moment", "2023-06-01")
Пример:
params.WithFilterLesserOrEquals("moment", "2023-06-01")
Пример:
params.WithFilterNotEquals("name", "0001")
Пример:
params.WithFilterEquivalence("code", "ms")
Пример:
params.WithFilterEquivalenceLeft("code", "ms")
Пример:
params.WithFilterEquivalenceRight("code", "ms")
Пример:
params.WithFilterNotEquivalence("code", "ms")
Пример:
params.WithFilterDeleted(true)
Пример:
params.WithFilterPrinted(true)
Пример:
params.WithFilterPublished(true)
Пример:
params.WithFilterArchived(true)
Пример:
params.WithGroupBy(moysklad.GroupByProduct)
Метод принимает указатель на сохранённый фильтр.
Пример:
params.WithNamedFilter(&NamedFilter{...})
Пример:
params.WithOrder("name")
Пример:
params.WithOrderAsc("name")
Пример:
params.WithOrderDesc("name")
Метод устанавливает лимит позиций в 100 единиц, а также применяет замену ссылок объектами для поля positions
Пример:
params.WithStockFiled()
Используется в отчёте "Остатки"
Пример:
params.WithStockType(moysklad.StockDefault)
Используется в отчётах
Пример:
params.WithInterval(moysklad.IntervalMonth)
Метод принимает time.Time
Пример:
params.WithMomentFrom(time.Now())
Метод принимает time.Time
Пример:
params.WithMomentTo(time.Now())
Для перехода к определённому сервису необходимо вызвать цепочку методов, аналогично пути запроса.
Сервис для работы с товарами.
Относительный путь: /entity/product
Цепочка вызовов от клиента будет выглядеть следующим образом:
client := moysklad.NewClient()
// `/entity/product`
_ = client.Entity().Product()
// `/entity/variant`
_ = client.Entity().Variant()
// `/context/companysettings`
_ = client.Context().CompanySettings()
// `/report/dashboard`
_ = client.Report().Dashboard()
Если возникает необходимость точечно запросить информацию о сущности, имея только её Meta
, можно использовать
метод FetchMeta
.
Чтобы использовать данный функционал необходимо точно знать, какой тип данных мы ожидаем получить в ответ.
Метод имеет следующую сигнатуру:
func FetchMeta[T any](ctx context.Context, client *Client, meta Meta, params *Params) (*T, *resty.Response, error)
Пример:
productFromMeta, resp, err := moysklad.FetchMeta[moysklad.Product](ctx, client, product.GetMeta(), nil)
package main
import (
"context"
"fmt"
"github.com/arcsub/go-moysklad/moysklad"
"os"
)
func main() {
// инициализируем простой клиент с аутентификацией по паре логин/пароль
client := moysklad.NewClient().
WithBasicAuth(os.Getenv("MOYSKLAD_USERNAME"), os.Getenv("MOYSKLAD_PASSWORD")).
WithDisabledWebhookContent(true)
// сервис для работы с товарами
productService := client.Entity().Product()
// выполняем запрос на получение списка товаров без дополнительных параметров
products, _, err := productService.GetList(context.Background())
if err != nil {
panic(err)
}
// выводим названия полученных товаров
for _, product := range products.Rows {
fmt.Println(product.GetName())
}
// создадим новый товар
product := new(moysklad.Product)
product.SetName("Created Product")
// отправим запрос на создание товара
// в качестве аргументов передадим контекст и товар
productCreated, _, err := productService.Create(context.Background(), product)
if err != nil {
panic(err)
}
// выведем название созданного товара
fmt.Println(productCreated.GetName())
// изменим название товара
productCreated.SetName("Updated Product")
// отправим запрос на изменение товара
// в качестве аргументов передадим контекст, ID изменяемой сущности и изменённый товар
productUpdated, _, err := productService.Update(context.Background(), productCreated.GetID(), productCreated)
if err != nil {
panic(err)
}
// выведем название изменённого товара
fmt.Println(productUpdated.GetName())
// отправим запрос на удаление товара
// в качестве аргументов передадим контекст и ID удаляемой сущности
success, _, err := productService.Delete(context.Background(), productUpdated.GetID())
if err != nil {
panic(err)
}
// выведем состояние выполненного запроса, где true - успешно удалено, false – не удалено, см ошибки
fmt.Println("Deleted", success)
}
Буду рад видеть ваши идеи и предложения в Issues.