ColorMeShop - the Ruby gem for the カラーミーショップ API

カラーミーショップ APIでは、受注の検索や商品情報の更新を行うことができます。

はじめに、カラーミーデベロッパーアカウントを用意します。デベロッパー登録ページから登録してください。

次に、登録ページからアプリケーション登録を行ってください。 スマートフォンのWebViewを利用する場合は、リダイレクトURLにurn:ietf:wg:oauth:2.0:oobを入力してください。

その後、カラーミーショップアカウントの認証ページを開きます。認証ページのURLは、https://api.shop-pro.jp/oauth/authorizeに必要なパラメータをつけたものです。

scopeは、以下のうち、アプリケーションが利用したい機能をスペース区切りで指定してください。

以下のようなURLとなります。

https://api.shop-pro.jp/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URL&response_type=code&scope=read_products%20write_products

初めてこのページを訪れる場合は、カラーミーショップアカウントのIDとパスワードの入力を求められます。 承認ボタンを押すと、このアプリケーションがショップのデータにアクセスすることが許可され、リダイレクトURLへリダイレクトされます。

承認された場合は、codeというクエリパラメータに認可コードが付与されます。承認がキャンセルされた、またはエラーが起きた場合は、 errorパラメータにエラーの内容を表す文字列が与えられます。

アプリケーション登録時のリダイレクトURLにurn:ietf:wg:oauth:2.0:oobを指定した場合は、以下のようなURLにリダイレクトされます。 末尾のパスが認可コードになっています。

https://api.shop-pro.jp/oauth/authorize/AUTH_CODE

認可コードの有効期限は発行から10分間です。

最後に、認可コードとアクセストークンを交換します。以下のパラメータを付けて、https://api.shop-pro.jp/oauth/tokenへリクエストを送ります。

# curl での例

$ curl -X POST \\
  -d'client_id=CLIENT_ID' \\
  -d'client_secret=CLIENT_SECRET' \\
  -d'code=CODE' \\
  -d'grant_type=authorization_code'   \\
  -d'redirect_uri=REDIRECT_URI'  \\
  'https://api.shop-pro.jp/oauth/token'

リクエストが成功すると、以下のようなJSONが返ってきます。

{
  \"access_token\": \"d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX\",
  \"token_type\": \"bearer\",
  \"scope\": \"read_products write_products\"
}

アクセストークンに有効期限はありませんが、許可済みアプリケーション一覧画面から失効させることができます。なお、同じ認可コードをアクセストークンに交換できるのは1度だけです。

取得したアクセストークンは、Authorizationヘッダに入れて使用します。以下にショップ情報を取得する際の例を示します。

# curlの例

$ curl -H 'Authorization: Bearer d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX' https://api.shop-pro.jp/v1/shop.json

カラーミーショップAPI v1では

• エラーコード
• エラーメッセージ
• ステータスコード

の配列でエラーを表現します。以下に例を示します。

{
  \"errors\": [
    {
      \"code\": 404100,
      \"message\": \"レコードが見つかりませんでした。\",
      \"status\": 404
    }
  ]
}

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.1.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://shop-pro.jp/?mode=inq

To build the Ruby code into a gem:

gem build color_me_shop.gemspec

Then either install the gem locally:

gem install ./color_me_shop-1.1.0.gem

(for development, run gem install --dev ./color_me_shop-1.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'color_me_shop', '~> 1.1.0'

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'color_me_shop', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# Load the gem
require 'color_me_shop'

# Setup authorization
ColorMeShop.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ColorMeShop::CategoryApi.new

begin
  #商品カテゴリー一覧を取得
  result = api_instance.get_product_categories
  p result
rescue ColorMeShop::ApiError => e
  puts "Exception when calling CategoryApi->get_product_categories: #{e}"
end

All URIs are relative to https://api.shop-pro.jp

• ColorMeShop::ApplicationCharge
• ColorMeShop::ApplicationChargeCreateResponse
• ColorMeShop::Customer
• ColorMeShop::Delivery
• ColorMeShop::DeliveryChargeByPrefecture
• ColorMeShop::DeliveryDateSetting
• ColorMeShop::Meta
• ColorMeShop::Payment
• ColorMeShop::Product
• ColorMeShop::ProductCategory
• ColorMeShop::ProductGroup
• ColorMeShop::ProductOption
• ColorMeShop::ProductPickup
• ColorMeShop::ProductUpdateRequest
• ColorMeShop::ProductVariant
• ColorMeShop::RecurringApplicationCharge
• ColorMeShop::RecurringApplicationChargeCreateResponse
• ColorMeShop::Sale
• ColorMeShop::SaleDelivery
• ColorMeShop::SaleDetail
• ColorMeShop::ScriptTag
• ColorMeShop::Shop
• ColorMeShop::Stock

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://api.shop-pro.jp/oauth/authorize
• Scopes:
  • read_products: 商品データを参照
  • write_products: 在庫データを更新
  • read_sales: 受注・顧客データを参照
  • write_sales: 受注データを更新