https://github.com/t4traw/yahoo_store_api
Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるruby gem
https://github.com/t4traw/yahoo_store_api
api gem ruby yahoo yahoo-api yahoo-shopping
Last synced: about 2 months ago
JSON representation
Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるruby gem
- Host: GitHub
- URL: https://github.com/t4traw/yahoo_store_api
- Owner: t4traw
- License: mit
- Created: 2017-05-02T03:34:23.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2022-04-13T15:02:28.000Z (about 4 years ago)
- Last Synced: 2025-12-30T08:19:17.933Z (4 months ago)
- Topics: api, gem, ruby, yahoo, yahoo-api, yahoo-shopping
- Language: Ruby
- Homepage: https://rubygems.org/gems/yahoo_store_api
- Size: 93.8 KB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YahooStoreApi
**⚠️Deprecated⚠️**
YahooのAPI認証がv1からv2に移行しており、自分自身EC関連の業務から離れているため、メンテナンスができません。
> 2021年8月3日をもちましてYahoo! ID連携 v1の新規の登録を終了いたしました。
> 2022年4月27日にYahoo! ID連携 v1の利用を終了いたしますのでv2への移行が必要です。
---
[](https://badge.fury.io/rb/yahoo_store_api)
[](https://github.com/t4traw/yahoo_store_api/actions/workflows/main.yml)
[](https://codeclimate.com/github/t4traw/yahoo_store_api)
Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるrubyラッパーです。
## できること
* 商品に関連するAPI
* 商品参照API(`get_item`)
* 商品登録API(`set_item`)
* 商品アップロードAPI(`upload_item_file`)
* 商品削除API(`delete_item`)
* 画像に関連するAPI
* 商品画像一括アップロードAPI(`upload_item_image_pack`)
* 在庫に関連するAPI
* 在庫参照API(`get_stock`)
* 在庫更新API(`set_stock`)
* 出品管理に関連するAPI
* 全反映予約API(`reserve_publish`)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'yahoo_store_api'
```
## 事前準備
事前にストア出品アカウントと連携した認証コードが必要になります。
まず、Yahooデベロッパーネットワークの[Yahoo!ショッピングのストア運営をサポートするAPIを利用したアプリケーション](https://e.developer.yahoo.co.jp/shopping/register)にアプリケーションを登録します。
登録が終えたら、次に[認可コードを取得](https://developer.yahoo.co.jp/yconnect/server_app/explicit/authorization.html)する必要があります。ページに表示するかリダイレクトした時のパラメーターにある認証コードを取得します。
※シンプルにページ上に認証コードを表示させる例: https://auth.login.yahoo.co.jp/yconnect/v1/authorization?response_type=code+id_token&client_id=[上で登録したアプリケーションID]&state=foobar&redirect_uri=oob&nonce=hogehoge
stateやnonceなどは[Authorizationエンドポイント](https://developer.yahoo.co.jp/yconnect/server_app/explicit/authorization.html)に詳細がありますので、適宜変更してください。
## Initialize
ストアアカウント、上で登録したアプリケーションid、シークレット、取得した認証コードでインスタンスを生成します。
redirect_uriにはアプリケーション登録時に設定したフルURL（もしくはカスタムURIスキーム）を指定してください。登録済みの戻り先URLが1つしかない場合は省略可能です。戻り先URLがない場合はoobを指定してください。
```ruby
client = YahooStoreApi::Client.new(
seller_id: YOUR_STORE_ID, # ストアアカウントid
application_id: YOUR_APPLICATION_ID, # アプリケーションid
application_secret: YOUR_SECRET, # シークレット
redirect_uri: 'oob', # 省略可能
authorization_code: AUTHORIZATION_CODE # 認証コード
)
```
なお、この認証コードは1回のみ使用可能で、次からはリフレッシュトークンを使用するか、再度認証コードを取得する必要があります。リフレッシュトークンは生成したインスタンスから取得する事ができます。
```ruby
puts client.refresh_token
```
```ruby
client = YahooStoreApi::Client.new(
seller_id: YOUR_STORE_ID, # ストアアカウントid
application_id: YOUR_APPLICATION_ID, # アプリケーションid
application_secret: YOUR_SECRET, # シークレット
refresh_token: YOUR_REFRESH_TOKEN # リフレッシュトークン
)
```
## Usage
### 商品情報の参照
ストアに登録されている商品情報を取得できます。
```ruby
item = client.get_item('test123')
# 商品名を取得
item.name
# 通常販売価格を取得
item.price
# 取得したすべての情報をhashで出力
item.all
```
### 商品情報の登録
項目については[Yahoo:商品登録API](https://developer.yahoo.co.jp/webapi/shopping/editItem.html)を参照してください。
```ruby
item = client.edit_item({
item_code: 'test1234',
name: 'test_item',
path: 'test_category',
price: 1000,
})
# 送信結果をhashで出力
item.all
```
### 商品情報の一括登録
csvファイルをアップロードする事で商品情報の一括登録ができます。
```ruby
item = client.upload_item_file("your/upload/file.csv")
```
### 商品情報の更新
:bangbang: APIの仕様で、更新したいカラムのみ送信して更新が **できません** :bangbang:
商品を登録・更新する場合、**省略した項目はデフォルト値で上書きされるので注意してください**。
なので、一度情報を取得し、必要な箇所を書き換えて送信する必要があります。
```ruby
data = client.get_item(code).all
data["name"] = 'edit item'
data["caption"] = 'edit caption'
client.edit_item(data)
```
### 在庫情報の参照
ストアに登録されている商品の在庫情報を取得できます。
```ruby
stock = client.get_stock('test123')
# 在庫数の取得
stock.quantity
# 取得したすべての情報をhashで出力
stock.all
```
### 全反映予約
反映予約をします。
```ruby
pub = client.reserve_publish
# 結果を取得
pub.status
```