Git Product home page Git Product logo

rms_item_api's Introduction

RmsItemApi

Build Status Code Climate

楽天市場に出店している店舗が使えるRMSの商品APIを叩くためのrubyラッパーです。シンプルなCRUD(作成、取得、更新、削除)のみを実装してあります。検索と複数更新は必要があれば追加したいと思います。

Installation

Add this line to your application's Gemfile:

gem 'rms_item_api'

Usage

取得や更新する項目に関しては楽天RMS WEB APIのドキュメント「拡張サービス一覧>WEB APIサービス>RMS WEB SERVICE : ItemAPI」(要ログイン)にて。

Initialize

RMS内の「拡張サービス一覧>WEB APIサービス>利用設定」にあるserviceSecretとlicenseKeyが必要です(事前にWEB APIの利用申し込みが必要です)。

client = RmsItemApi::Client.new(
  serviceSecret: "your_serviceSecret",
  licenseKey: "your_licenseKey"
)

Get

RMSに登録している商品情報を商品管理番号を指定して取得することができます。

item = client.get('test123')

# 正常なレスポンスが返ってきているかをtrue/falseで返します
item.is_success?

# 商品名を取得
item.item_name
# 表示価格を取得
item.item_price
# 全ての取得データをhashで出力します
item.all

Insert

RMSに商品情報を登録することができます。

item = client.insert({
  item_url: 'test123',
  item_name: 'api_insert_test_item',
  item_price: '298000',
  genreId: 564040,
  images: {
    image: {
      image_url: 'http://image.rakuten.co.jp/your_shop_id/cabinet/test.jpg'
    }
  },
  item_layout: 2,
  is_included_postage: true
})

# 正常なレスポンスが返ってきているかをtrue/falseで返します
item.is_success?

Update

RMSに登録されている商品情報を更新することができます。

item = client.update({
  item_url: 'test123',
  item_name: 'api_update_test_item',
  item_price: '198000',
  categories: {
    categoryInfo: {
      categoryId: '0000000123'
    }
  }
})

Delete

RMSに登録されている商品情報を削除することができます。

item = client.delete({
  item_url: 'test123',
})

rms_item_api's People

Contributors

t4traw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.