Module: ColorMeShop

Defined in:: lib/color_me_shop/api_error.rb,
lib/color_me_shop.rb,
lib/color_me_shop/version.rb,
lib/color_me_shop/api_client.rb,
lib/color_me_shop/api/etc_api.rb,
lib/color_me_shop/models/meta.rb,
lib/color_me_shop/models/sale.rb,
lib/color_me_shop/models/shop.rb,
lib/color_me_shop/api/gift_api.rb,
lib/color_me_shop/api/sale_api.rb,
lib/color_me_shop/api/shop_api.rb,
lib/color_me_shop/models/stock.rb,
lib/color_me_shop/api/group_api.rb,
lib/color_me_shop/api/stock_api.rb,
lib/color_me_shop/configuration.rb,
lib/color_me_shop/api/charge_api.rb,
lib/color_me_shop/api/script_api.rb,
lib/color_me_shop/models/payment.rb,
lib/color_me_shop/models/product.rb,
lib/color_me_shop/api/payment_api.rb,
lib/color_me_shop/api/product_api.rb,
lib/color_me_shop/models/customer.rb,
lib/color_me_shop/models/delivery.rb,
lib/color_me_shop/api/category_api.rb,
lib/color_me_shop/api/customer_api.rb,
lib/color_me_shop/api/delivery_api.rb,
lib/color_me_shop/models/script_tag.rb,
lib/color_me_shop/models/sale_detail.rb,
lib/color_me_shop/models/product_group.rb,
lib/color_me_shop/models/sale_delivery.rb,
lib/color_me_shop/models/product_option.rb,
lib/color_me_shop/models/product_pickup.rb,
lib/color_me_shop/models/product_variant.rb,
lib/color_me_shop/models/product_category.rb,
lib/color_me_shop/models/application_charge.rb,
lib/color_me_shop/models/delivery_date_setting.rb,
lib/color_me_shop/models/product_update_request.rb,
lib/color_me_shop/models/recurring_application_charge.rb,
lib/color_me_shop/models/delivery_charge_by_prefecture.rb,
lib/color_me_shop/models/application_charge_create_response.rb,
lib/color_me_shop/models/recurring_application_charge_create_response.rb

Overview

#カラーミーショップ API

## カラーミーショップ API [カラーミーショップ](shop-pro.jp) APIでは、受注の検索や商品情報の更新を行うことができます。 ## 利用手順はじめに、カラーミーデベロッパーアカウントを用意します。(api.shop-pro.jp/developers/sign_up)から登録してください。次に、(api.shop-pro.jp/oauth/applications/new)からアプリケーション登録を行ってください。スマートフォンのWebViewを利用する場合は、リダイレクトURLに‘urn:ietf:wg:oauth:2.0:oob`を入力してください。その後、カラーミーショップアカウントの認証ページを開きます。認証ページのURLは、`api.shop-pro.jp/oauth/authorize`に必要なパラメータをつけたものです。 |パラメータ名|値| |—|—| |`client_id`|アプリケーション詳細画面で確認できるクライアントID| |`response_type`|"code"という文字列| |`scope`| 別表参照| |`redirect_url`|アプリケーション登録時に入力したリダイレクトURL| `scope`は、以下のうち、アプリケーションが利用したい機能をスペース区切りで指定してください。 |スコープ|機能| |—|—| |`read_products`|商品データの参照| |`write_products`|在庫データの更新| |`read_sales`|受注・顧客データの参照| |`write_sales`|受注データの更新| 以下のようなURLとなります。 “` 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にリダイレクトされます。末尾のパスが認可コードになっています。 “` api.shop-pro.jp/oauth/authorize/AUTH_CODE “` 認可コードの有効期限は発行から10分間です。最後に、認可コードとアクセストークンを交換します。以下のパラメータを付けて、`api.shop-pro.jp/oauth/token`へリクエストを送ります。 |パラメータ名|値| |—|—| |`client_id`|アプリケーション詳細画面に表示されているクライアントID| |`client_secret`|アプリケーション詳細画面に表示されているクライアントシークレット| |`code`|取得した認可コード| |`grant_type`|"authorization_code"という文字列| |`redirect_uri`|アプリケーション登録時に入力したリダイレクトURL| “`console # 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’ \ ‘api.shop-pro.jp/oauth/token’ “‘ リクエストが成功すると、以下のようなJSONが返ってきます。 “`json { "access_token": "d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX", "token_type": "bearer", "scope": "read_products write_products" } “` アクセストークンに有効期限はありませんが、許可済みアプリケーション一覧画面から失効させることができます。なお、同じ認可コードをアクセストークンに交換できるのは1度だけです。取得したアクセストークンは、Authorizationヘッダに入れて使用します。以下にショップ情報を取得する際の例を示します。 “`console # curlの例 $ curl -H ’Authorization: Bearer d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX’ api.shop-pro.jp/v1/shop.json “‘ ## エラーカラーミーショップAPI v1では - エラーコード - エラーメッセージ - ステータスコードの配列でエラーを表現します。以下に例を示します。 “`json { "errors": [ { "code": 404100, "message": "レコードが見つかりませんでした。", "status": 404 } ] } “`

OpenAPI spec version: 1.0.0

Generated by: openapi-generator.tech OpenAPI Generator version: 3.2.0-SNAPSHOT

Defined Under Namespace

Classes: ApiClient, ApiError, ApplicationCharge, ApplicationChargeCreateResponse, CategoryApi, ChargeApi, Configuration, Customer, CustomerApi, Delivery, DeliveryApi, DeliveryChargeByPrefecture, DeliveryDateSetting, EtcApi, GiftApi, GroupApi, Meta, Payment, PaymentApi, Product, ProductApi, ProductCategory, ProductGroup, ProductOption, ProductPickup, ProductUpdateRequest, ProductVariant, RecurringApplicationCharge, RecurringApplicationChargeCreateResponse, Sale, SaleApi, SaleDelivery, SaleDetail, ScriptApi, ScriptTag, Shop, ShopApi, Stock, StockApi

Constant Summary collapse

VERSION =

'1.1.1'

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block.

ColorMeShop.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/color_me_shop.rb', line 67

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end