BASEのAPIでできること｜使い方や申請・設定方法を解説【2024年最新版】

BASE（ベイス）は、誰でも簡単に無料でネットショップを開けるEコマースプラットフォームです。BASEにAPIを連携すると、さらにショップの効率化につなげられます。

しかし「BASE APIの設定をしようとしても上手くいかない」とお悩みの企業担当者は多いのではないでしょうか？
そこで本記事では、

• 自社のBASEにAPIを連携したい
• BASE APIの設定がなぜ上手くいかないの？
• 実装できない場合の相談先を知りたい

とお悩みの方に向けて、BASE APIの概要から、BASE APIの機能や活用事例、BASE APIを設定する方法などについて解説します。

※BASE APIがうまく設定できない、BASE APIの設定について相談したいという方は、システム幹事にご相談ください。専任のアドバイザーがヒアリングし、アドバイスします。相談料などは一切かかりませんので、お気軽にお問い合わせください。

【無料】BASEのAPIについて相談する

BASEのAPIとは？

画像引用：Base Developers

BASE APIとは、BASEと他のサービスを連携する仕組みです。APIは「Application Programing Interface」の略称。ソフト同士の機能を共有する仕組みのことで、BASEのAPIは2014年に運営会社のBASE株式会社によって発表されました。BASE APIを活用すると、BASE上の商品情報や注文情報などのデータを取得して外部システムに連携できます。そのため、機能を拡張できるほか、業務の効率化も期待できます。BASEで利用できるAPIの機能は下記の通りです。

• 商品情報の閲覧
• 注文情報の取得
• 商品情報の編集
• 商品情報の検索

BASE APIは無料で利用できる

BASE APIはショップオーナーであれば、誰でも無料で利用できます。後ほど使い方を説明しますが、BASEにAPIを使う許可を申請し、コードが送られてくるので外部システムと連携します。

【無料】BASEのAPIについて相談する

BASEのAPIでできること

ここから、BASE APIでできることや活用事例を解説します。

外部サイトに商品を掲載できる

画像引用：a-blogcms

BASE APIを使うと、ブログや企業サイトなどの自社サイトにBASEの商品を掲載でき、購入することが可能です。

BASEでのショップ運営の場合、デザインなどはBASEが指定するテンプレートに沿ったカスタマイズに限定されます。しかし、商品情報をBASE APIから自社サイトに読み込むと、自由にデザインや機能も変更可能です。

商品情報の一括編集ができる

BASE APIの使用で、商品情報の一括管理ができ、作業手間を省くことが可能です。外部サイトから商品の一括管理ができるようになったり、管理画面をひとつずつ編集するよりも効率が上がったりする場合があります。

BASE Appsをカスタマイズできる

BASE APIを使うことで、BASE Appsをカスタマイズできます。BASE Appsとは、ショップにより充実した設定を追加したり、新しい機能が必要なときに追加できる機能です。BASE Appsには、下記のように2種類の拡張機能があります。

• Official Apps：BASE独自で開発した拡張機能
• Connect Apps：企業と提携した拡張機能
  
  

開発者登録をするとBASE APIを使用でき、ショップの運営方針に合わせた機能やデザインのカスタマイズが可能です。クーポン発行機能やオリジナルデザインのTシャツやスマホケース作成機能など、ショップにとって便利な機能が多くあります。

【無料】BASEのAPIについて相談する

BASE APIの活用事例

BASE APIを活用した事例を3つ紹介します。

freee

画像引用：BASE

「freee」は個人事業主や法人向けのクラウド会計ソフトで、BASE連携機能の活用により、売上高・決済手数料・送料などの情報を自動で読み込むことが可能です。

手動で会計帳簿へ入力すると、 手間がかかったり、人的ミスも生じたりします。一方BASE連携機能を使うと、会計帳簿への転記作業が不要となり、作業時間を大幅に短縮できます。

Ameba Owned

画像引用：BASE

「Ameba Owned（アメーバ オウンド）」はブログ感覚でWebサイトが作れるサービスです。アメーバ オウンドとBASE APIを連携すると、初期費用、月額費用が無料でECサイトの機能を利用できるようになります。

【開発者向け】BASE DESIGN MARKET

画像引用：BASE

BASE DESIGN MARKETは有料デザインのテンプレートが集まるマーケットです。ネットショップオーナーではなく開発者（エンジニア）向けになりますが、HTML編集を活用するこでオリジナルのテンプレートが作れ、BASE DESIGN MARKETで販売することができます。

【無料】BASEのAPIについて相談する

BASE APIを設定する方法

1.BASE APIの利用申請
2.認可コードの取得と読み取り
3.アクセストークンの発行
4.商品情報などを取得
5.出力情報の活用

なお、先にBASEでショップを作り、アカウントを発行しておく必要があります。BSEでのショップの始め方が分からない方は「BASEとは？おすすめの人、メリットや手数料、成功事例を紹介！」をご覧ください。

1.BASE APIの利用申請

ショップアカウント取得後、 https://developers.thebase.in/ に行き、左下の「申請する」を選択します。

上のような画面に遷移するので、情報を埋めていきます。アプリのURLとコールバックのURLには、BASEで開設したショップURLを記入します。アプリのロゴ画像の入力は不要です。

利用権限は、利用したい目的に合わせ、取得したい情報にチェックを入れます。

開発者情報には、担当者名・住所・電話番号・メールアドレスが必須です。申請からメールが届くまで約1〜2週間かかります。

2.認可コードの取得と読み取り

1.URLの作成

認可コードは、BASE APIの「/1/oauth/authorize」で取得します。
URLには、自身のBASEのアカウントに発行されたID・利用申請時のコールバックURLなどを入力する必要があります。

クライアントIDが「example123」、コールバックURLが「https://example123.com/callback.php」の時、許可コードの取得URLは以下の通りです。

2. アプリとの連携の許可

許可のコードを取得するURLにアクセスすると、アプリ連携を許可する確認画面が表示されます。連携を許可します。

3. 認可コードの読み取り

パラメーターとして認可のコードが付与されたコールバックのURLに自動的にリダイレクトされるため、上記の認可コード「code=」以下の部分を読み取ります。
認可コードを取得するプログラムをPHPやPythonで書く場合、以下を実装します。

• 許可コードを取得するURLの作成
• リダイレクト後のURLから認可コードの部分を抜粋する機能
  
  

3.アクセストークンの発行

アクセストークンは、認可コードを取得したときと同様の手順で発行できます。

1. アクセストークン発行URL

gtant_type・client_id・client_secret・code・redirect_urlの5つのパラメータが必須です。

クライアントIDが「example123」、クライアントシークレットが「abcpong」、認可コードが「78x7y5z9」、アプリに登録したコールバックURLが「https://example123.com/callback.php」の場合、アクセストークン発行用URLは以下の通りです。

2.アクセストークンを抽出

アクセストークン発行URLで以下のようなレスポンスが返されます。

「access_token」の行に記載されているアクセストークンを抽出します。コーディングに必須な文字列です。その他の文字列などに関しては https://docs.thebase.in/docs/api/ を確認しましょう。

4.商品情報などを取得

BASEに登録されている商品情報などのデータも、同じ手順で取得できます。
BASE APIを使用する場合「3.アクセストークンの発行」で発行したアクセストークンに関する設定も必要です。ヘッダー部分は使用するプログラミング言語で異なるため、言語の記述方法に従って記載してください。完了後はJSON形式のテキストデータが返ってきます。

5.出力情報の活用

「4.商品情報などを取得」で取得したJSON形式のデータをPHPで読み込むと、外部サイトへの連携が可能です。CSV形式に変換すればExcelによる在庫管理もできるようになります。

【無料】BASEのAPIについて相談する

BASE APIがうまく設定できない理由と対処法

APIの利用回数上限に到達してしまった場合

利用規約にも書かれているように、API設定は1時間に最大5,000回、1日最大10万回が上限です。CSVデータ1行が1回という認識を持ちましょう。上限を超えるとエラーになってしまいます。5,000回になったら、時間が00分になるのを待つか、BASEに問い合わせて制限緩和依頼をすることで解消できます。

WordPressプラグインがうまく機能しない場合

WordPressのプラグインである「BASE 商品リスト」はBASE API機能の一部です。商品リスト以外の機能を使用する場合は、自力でPHPやPythonでのコーディングが必要になります。

原因がわからない場合

BASE APIがうまく設定できない理由が不明な場合、専門の人に任せることをおすすめします。申請から利用開始までが複雑なため、対応できない人も少なくないといった実態があります。
システム幹事にはBASE APIに対応できる会社があるので、お困り方はぜひ相談してください。

【無料】BASEのAPIについて相談する

BASE APIと連携できるツール

最後に、BASE APIと連携できるシステム・ツールを紹介します。

WordPress

画像引用：WordPress

WordPressは世界中で人気の高いオープンソースのCMS（コンテンツ・マネジメント・システム）です。無料で利用できるデザインテンプレートやプラグインが多くあり、Webの知識がなくてもブログが作成できます。

WordPressのメリットは、SEOに強く検索結果で上位表示しやすいことです。一方BASEはSEOに弱く、大手ECショップと比べて、自社のショップが上位表示されないというデメリットがあります。そのため、WordPressと連携することで集客効果につなげられます。

Lisket

画像引用：Lisket

「Lisket」は、ウェブ広告レポート自動作成・広告予算管理ツールです。導入実績が650社を突破しており、リスティング広告・SNS広告の主要媒体をまとめて管理できます。その結果、広告運用に費やされる時間が無くなり、配信状況を確認する時間を80%削減できます。

Canvath

画像引用：Canvath

「Canvath」は画像をアップロードするだけでクッション・マグカップ・トートバッグなど、オリジナルグッズが作れるサービスです。30,000人のネットショップユーザーが利用し、1ヵ月の発注回数は600回以上にも上ります。

バリュープレス

画像引用：バリュープレス
バリュープレスは、72,645社が選んだプレスリリース配信サービス。4,500媒体、6,000名のメディアリストから厳選したメディア、最大1,500件へプレスリリースしてくれます。

【無料】BASEのAPIについて相談する

BASEのAPIでできることについて解説しました

すでにBASEを持っており、効率化のためにAPIを実装したいが上手くいかないという企業の方に向け、BASE APIの概要から、機能や活用事例、設定する方法などについて解説しました。

BASE APIとは、BASEと他のサービスを連携する仕組みです。BASE APIを活用すると、BASE上の商品情報や注文情報などのデータを取得して外部システムに連携できます。そのため、機能を拡張できるほか、業務の効率化も期待できます。

BASE APIがうまく設定できない理由は、APIの利用回数上限に到達してしまった場合やWordPressプラグインがうまく機能しない場合などです。しかし、原因がわからない場合もあるでしょう。BASE APIの設定が上手くできない場合、知見を持った専門的な会社に相談するのがおすすめです。

※BASE APIがうまく設定できない、BASE APIの設定について相談したいという方は、システム幹事にご相談ください。専任のアドバイザーが最適な開発会社をご紹介します。相談料などは一切かかりませんので、お気軽にお問い合わせください。

コンサルタントのご紹介 岩田 専任のコンサルタントが、
お客様の予算と目的を丁寧にヒアリング。
最適な会社をピックアップ・ご紹介させていただきます！
初心者の方でも安心してご相談いただけます。

【無料】BASE APIの設定に詳しい開発会社を紹介してもらう