moysklad

README

moysklad

Библиотека для работы с JSON API Moysklad

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

ms := NewClient(API_TOKEN)

params := Params{Query: map[string]string{
	"limit": "10",
}}

// Получаем срез сущностей Товар
response, err := ms.Product(params).Get()

Documentation

Index

• Constants
• Variables
• type APIClient
  • func NewClient(token string) *APIClient
  • func (client *APIClient) Counterparty(params Params) *CounterpartyRequest
  • func (client *APIClient) Product(params Params) *ProductRequest
• type APIRequest
  • func NewRequest(client *APIClient, endPoint string, params Params) *APIRequest
• type CounterpartyRequest
  • func (client *CounterpartyRequest) Get() (counterparties []entities.CounterParty, err error)
  • func (client *CounterpartyRequest) GetByUUID(uuid string) (counterparty *entities.CounterParty, errors interface{})
• type Filter
• type Params
  • func (params *Params) AddFilter(key string, value string, operator string)
  • func (params *Params) AddQuery(key string, value string)
  • func (params Params) GetFilterString() (filters string)
• type ProductRequest
  • func (client *ProductRequest) Get() (products []entities.ProductEntity, err error)
  • func (client *ProductRequest) GetByUUID(uuid string) (product *entities.ProductEntity, errors interface{})
• type Response
• type ResponseData

Constants

const APIPath = "https://online.moysklad.ru/api/remap/1.2/"

APIPath базовый URL к API МойСклад

Variables

var MSPool []*APIClient

MSPool срез из экземпляров APIClient

Types

type APIClient

type APIClient struct {
	// contains filtered or unexported fields
}

APIClient экземпляр клиента МойСклад с токеном

func NewClient

func NewClient(token string) *APIClient

NewClient создаёт и возвращает ссылку на экземпляр APIClient

func (*APIClient) Counterparty

func (client *APIClient) Counterparty(params Params) *CounterpartyRequest

Counterparty устанавливает нужный endpoint

func (*APIClient) Product

func (client *APIClient) Product(params Params) *ProductRequest

Product устанавливает нужный endpoint

type APIRequest

type APIRequest struct {
	// contains filtered or unexported fields
}

APIRequest структура параметров запроса

func NewRequest

func NewRequest(client *APIClient, endPoint string, params Params) *APIRequest

NewRequest создаёт и возвращает ссылку на структуру запроса

type CounterpartyRequest

type CounterpartyRequest struct{ *APIRequest }

CounterpartyRequest структура для запросов сущности 'counterparty'

func (*CounterpartyRequest) Get

func (client *CounterpartyRequest) Get() (counterparties []entities.CounterParty, err error)

Get возвращает список сущностей

func (*CounterpartyRequest) GetByUUID

func (client *CounterpartyRequest) GetByUUID(uuid string) (counterparty *entities.CounterParty, errors interface{})

GetByUUID возвращает сущность по UUID

type Filter

type Filter struct {
	Key      string
	Value    string
	Operator string
}

Filter структура фильтра

type Params

type Params struct {
	Filters []Filter
	Query   map[string]string
}

Params структура параметров

func (*Params) AddFilter

func (params *Params) AddFilter(key string, value string, operator string)

AddFilter Допустимые операторы: ['=', '>', '<', '>=', '<=', '!=', '~', '~=', '=~']

func (*Params) AddQuery

func (params *Params) AddQuery(key string, value string)

AddQuery добавляет параметр к запросу

func (Params) GetFilterString

func (params Params) GetFilterString() (filters string)

GetFilterString склеивает фильтры в строку и возвращает

type ProductRequest

type ProductRequest struct{ *APIRequest }

ProductRequest структура для запросов сущности 'product'

func (*ProductRequest) Get

func (client *ProductRequest) Get() (products []entities.ProductEntity, err error)

Get возвращает список сущностей

func (*ProductRequest) GetByUUID

func (client *ProductRequest) GetByUUID(uuid string) (product *entities.ProductEntity, errors interface{})

GetByUUID возвращает сущность по UUID

type Response

type Response struct {
	Index int
	Body  []byte
}

Response структура для хранения ответа параллельных запросов

type ResponseData

type ResponseData struct {
	Meta struct {
		Size int `json:"size"`
	} `json:"meta"`
	Rows []map[string]interface{} `json:"rows"`
}

ResponseData структура для десериализации ответа