insales/insales_api

Gem for accessing the InSales REST web services

InsalesApi gem

Insales api client based on ActiveResource.

Rails application example is here.

Install

Add to Gemfile:

gem 'insales_api'

Initialize

class MyApp < InsalesApi::App
  self.api_key = 'api_key'
end

MyApp.configure_api('domain', 'password')

Use

order = InsalesApi::Order.find 123

# singleton resources
account = InsalesApi::Account.find

Handling Insales API request limit

There is a 500 requests per 5 minutes limit for Insales API. To handle this limitation gracefully, use InsalesApi.wait_retry method:

# prepare a handler for request limit case
notify_user = Proc.new do |wait_for, attempt, max_attempts, ex|
  puts "API limit reached. Waiting for #{wait_for} seconds. Attempt #{attempt}/#{max_attempts}"
end

# perform 10 attempts to get products
InsalesApi.wait_retry(10, notify_user) do |x|
  puts "Attempt ##{x}."
  products = InsalesApi::Products.all
end

If you don't need to cap the attempts number or you don't want to do any special processing, simply drop the arguments:

InsalesApi.wait_retry do
  products = InsalesApi::Products.all # will try to get products until the limit resets
end

insales_api's Issues

Как правильно работает групповое обновление вариантов?

Добрый день!

не понял как правильно работает - group_update в вариантах.

Перенёс код в product и заменил group_update на variants_group_update.
Теперь url стал вида как на api.insales.ru - /admin/products/variants_group_update.xml
И происходит обновление.

Failed. Response code = 401. Response message = Unauthorized

Из консоли (rails c) всё работает, а вот из контроллера выдаёт ошибку. Я же правильно понял что из любого контроллера можно делать вызов типа product = InsalesApi::Product.find (id) -?

Можно заменить xml на json?

Добрый день!
В xml не все значения есть
Например image_ids отсутствует у вариантов.

Если поменять здесь на json , то появляется
https://github.com/insales/insales_api/blob/master/lib/insales_api/base.rb

Описание

В описании написано - products = InsalesApi::Products.all
точно Products, а не Product - ?

Как правильно создать заказ (Order)?

Подскажите, как правильно создать новый заказ через API?

Например, такой заспрос:

    order = InsalesApi::Order.create! payment_title: "Наличным курьеру",
                                      payment_description: "Наличными курьеру",
                                      delivery_description: "Самовывоз (На пункте выдачи)",

                                      client: {
                                          email: "[email protected]",
                                          name: "TEST",
                                          phone: "[phone]"
                                      },
                                      order_lines_attributes: [{
                                                                   product_id: product_id,
                                                                   quantity: 1
                                                               }]

Возвращает ошибку: NameError (undefined local variable or method `order_lines' for #<InsalesApi::Order:0x00007f0a3537a758>)

Если вместо :order_lines_attributes использовать order_lines, то возникает другая ошибка: NoMethodError (undefined method `order_lines_attributes' for #<InsalesApi::Client:0x00007f0a35659b40>)

Не работает редактирование "значений дополнительных полей"

Пытаюсь сделать примерно так:

order = InsalesApi::Order.find(id)
field = order.fields_values.first
field.value = "test"
order.save # => true

Но поле не изменяется.

Загрузка архива с темой

Целесообразно реализовать возможность загрузки темы в виде архива.
Публикация темы целиком полезна при передачи в тестирование/продакшн изменений. Можно сказать, это "чистая установка".

Такая возможность позволит реализовать, например, версионирование темы.
В случае, если код темы хранится в git, возможность программной загрузки архива с темой позволит автоматически теггировать ревизию. Это, в свою очередь, позволит быстро "задеплоить" нужную версию.

Если загрузка темы архивом будет реализована в бекенде, сообщество самостоятельно, если это потребуется, реализует поддержку этой возможности в api-обертке.