BASE API のドキュメントです
Switch branches/tags
Nothing to show
Clone or download
Latest commit c0d5e8d Jul 17, 2018
Permalink
Failed to load latest commit information.
samples searchのサンプルを追加 Jan 4, 2016
README.md 検索の説明を追加 Jul 17, 2018
base_api_v1_categories.md Categories APIのドキュメントを3階層カテゴリー対応版に修正 Sep 29, 2016
base_api_v1_categories_add.md Categories APIのドキュメントを3階層カテゴリー対応版に修正 Sep 29, 2016
base_api_v1_categories_delete.md Categories APIのドキュメントを3階層カテゴリー対応版に修正 Sep 29, 2016
base_api_v1_categories_edit.md Categories APIのドキュメントを3階層カテゴリー対応版に修正 Sep 29, 2016
base_api_v1_delivery_companies.md DeliveryCompaniesのAPIを追加 Dec 8, 2015
base_api_v1_item_categories_add.md gistから移行 Apr 20, 2015
base_api_v1_item_categories_delete.md gistから移行 Apr 20, 2015
base_api_v1_item_categories_detail.md gistから移行 Apr 20, 2015
base_api_v1_items.md 商品一覧APIの並び替え項目にmodified追加 Feb 13, 2018
base_api_v1_items_add.md Update base_api_v1_items_add.md Mar 16, 2018
base_api_v1_items_add_image.md proper_price追加 Sep 7, 2017
base_api_v1_items_delete.md gistから移行 Apr 20, 2015
base_api_v1_items_delete_image.md proper_price追加 Sep 7, 2017
base_api_v1_items_delete_variation.md proper_price追加 Sep 7, 2017
base_api_v1_items_detail.md proper_price追加 Sep 7, 2017
base_api_v1_items_edit.md proper_price追加 Sep 7, 2017
base_api_v1_items_edit_stock.md proper_price追加 Sep 7, 2017
base_api_v1_oauth_access_token.md Basic認証をサポートする Dec 1, 2016
base_api_v1_oauth_authorize.md gistから移行 Apr 20, 2015
base_api_v1_oauth_refresh_token.md Basic認証をサポートする Dec 1, 2016
base_api_v1_orders.md コイン対応、かんたん発送App対応 Jul 11, 2018
base_api_v1_orders_detail.md コイン対応、かんたん発送App対応 Jul 11, 2018
base_api_v1_orders_edit_status.md コイン対応、かんたん発送App対応 Jul 11, 2018
base_api_v1_savings.md Savingsのレスポンスの例を修正 Oct 18, 2017
base_api_v1_search.md 検索の説明を追加 Jul 17, 2018
base_api_v1_search_refresh.md gistから移行 Apr 20, 2015
base_api_v1_users_me.md /1/users/meのドキュメント修正 Dec 3, 2015

README.md

BASE API v1 ドキュメント (β版)

BASEのAPIの開発者向けのドキュメントです。

概要

このAPIを使うと、あなたのアプリケーションとBASEを連携させることができます。

例えば

  • BASEのアカウントでログインする
  • BASEのショップの商品情報を取得する
  • BASEのショップの商品情報を更新する
  • BASEのショップの注文情報を取得する

※ APIは順次公開していく予定です。

仕様

エンドポイント

https://api.thebase.in/ 配下に各種APIが用意されています。 (httpsのみ)

認証

OAuth2.0に対応

Authorizationヘッダーでアクセストークンを送信して認証します。

Authorization: Bearer {Access_Token}

リフレッシュトークンも発行しています。

OAuth2.0の仕様については、下記の外部サイトを参照ください。

OAuth2.0のclient_idとclient_secretの取得には、BASE Developersへの利用登録と利用許可が必要です。下記URLから申請いただけます。

scope

  • read_users - ユーザー情報を取得 (デフォルトで付与)
  • read_users_mail - ユーザーのメールアドレスを取得
  • read_items - 商品情報を取得
  • read_orders - 注文情報を取得
  • read_savings - 振込申請情報を取得
  • write_items - 商品情報を更新
  • write_orders - 注文情報を更新

レスポンス

JSON形式でレスポンスを返します。

正常な場合はHTTPステータスコード 200 OKを返します。

エラーの場合はHTTPステータスコード 400 Bad Requestを返します。

エラーレスポンスの例

{
  "error":"invalid_request",
  "error_description":"アクセストークンが無効です。"
}

API

OAuth

Users

Items

Categories

ItemCategories

Orders

Savings

DeliveryCompanies

Search

APIの利用制限

現在はユーザーの1時間の利用上限を5000回、1日の利用上限を100000回に設定しています。

上限を超えるとエラーレスポンスを返します。00分になると利用回数がリセットされます。

{
  "error":"hour_api_limit",
  "error_description":"1時間のAPIの利用上限を超えました。時間が変わってからもう一度アクセスしてください。"
}
{
  "error":"day_api_limit",
  "error_description":"1日のAPIの利用上限を超えました。日付が変わってからもう一度アクセスしてください。"
}

サンプルプログラム

注意点

BASE APIは現在β版のため仕様が変更される場合があります。

API利用規約

http://thebase.in/pages/api_term

お問い合わせ

developers[at]thebase.in

BASE Developers https://developers.thebase.in