BASEのAPIを利用すると何ができるの？使い方・申請方法などを徹底解説していきます。

BASE　API

「BASEのAPIを利用すると何ができるんだろう」

「BASEのAPIってどうやったら使えるの？」

といった疑問を抱えている、Web担当者・個人事業主の方もいらっしゃるのではないでしょうか？

BASEの基本的な機能のみでネットショップの作成や運営はできますが、BASE APIを活用すると、さらに効率的に作業できるようになります。BASE APIでは、BASEの出店者向けにサービスを開発することも可能です。本記事では、

BASE APIでできること
BASE APIの具体的な使い方
BASE API利用時の注意点

について詳しく解説していきます。実際の活用事例も紹介しているので、ぜひ参考にしてみてください。

BASE APIでできること

BASE APIを使って実現できることは様々です。たとえば、BASEでショップを出店している場合、自社で作成した外部のWebサイトにBASEの商品を掲載できます。また、商品管理の効率化や、クラウドサービスとの連携なども可能に。

BASE APIとは？

そもそもAPIとは「Application Programming Interface」の略語で、ソフトウェアの機能を外部から利用するためのツール。

BASE APIを使うと、BASEのサービスとして提供されている商品情報・顧客情報の管理や、ショップ情報の検索などの機能が利用できるようになります。

以下では、BASE APIでできることの例を紹介します。

①：BASEで販売している商品を外部サイトに掲載できる

通常の方法でBASEのショップを運営する場合、BASEのドメイン内に開設したショップページで商品を販売することが一般的です。BASEのショップページは標準機能でも柔軟なカスタマイズが可能なものの、テンプレートの範囲を超えた大幅なデザイン変更や機能追加はできません。

そこで、BASE APIを使って商品情報を読み込み、自社のWebサイト上に掲載すれば、デザインや機能を自由に設定することが可能です。

②：商品データの一括編集で効率化ができる

BASEの管理画面では、出品している商品の一括編集や一括削除などの操作ができません。
CSVファイルを利用した一括出品機能があるものの、設定できる商品画像の数が限られるなどの制限があります。数多くの商品をBASEで出品している場合、管理画面からの操作では手間がかかる傾向も。

BASE APIには、商品情報などを一括で編集する機能が用意されています。そのため、BASE APIを利用するプログラムを作ると、ショップ運営業務の効率化が可能です。

③：クラウドサービスとの連携ができる

企業や個人としてクラウドサービスやアプリの開発・運営を行っている場合、BASE APIによってBASEとの連携機能が作れます。

例えば、オリジナルのTシャツやマグカップなどを自分でデザインできるWebサイトに、作った商品を手軽にBASEへ出品できる機能を追加することも可能に。BASEとの連携機能を実装すると、自社サービスの付加価値を高めることができます。

BASE APIの活用事例

BASE APIを活用して作られた各種サービスは、公式サイト内の「BASE Apps」ページから見ることが可能です。以下では、BASEとの連携機能を持つサービスを紹介します。

活用事例①：会計ソフト「freee」への自動入力

freee BASE連携サービス

出典：https://developers.thebase.in

「freee」は、個人事業主や法人向けに提供されているクラウド会計ソフトです。「freee」にはBASEとの連携により、ショップデータを自動で読み込む機能が実装されています。

取引数の多いネットショップでは、入金や手数料、注文のキャンセルなど処理すべき会計情報が多い傾向です。手作業で記帳を行うとミスが発生しやすく、時間と手間がかかってしまうことも。

「freee」のBASE連携機能を使えば、売上高だけでなく、決済手数料や送料などの細かな情報まで自動で読み込めるため効率的です。

活用事例②：「Ameba Owned」のネットショップ作成機能

出典：https://developers.thebase.in

「Ameba Owned」はWebサイトの制作サービスで、デザイン性の高いWebサイトが簡単に作れます。「Ameba Owned」のBASE連携機能を使うと、自作のWebサイトにEC機能を追加することが可能に。デザインやレイアウトの自由度が高いWebサイト上で、BASEに出品した商品を販売できます。

さらに「Ameba Owned」の管理画面上から商品登録や売上の確認ができる点も便利なポイントといえるでしょう。

BASE APIの使い方

ここからは、BASE APIを実際に使用する際の流れについて解説します。

BASE APIは、PHPやPythonなどのプログラミング言語から利用可能です。ただし、利用開始の申請や、認可コード・アクセストークンの取得などを行う必要があります。

BASE APIの利用申請から、取得した商品情報などを活用するまでの手順は以下の通りです。

STEP1：BASE APIの利用申請を行う

最初に、BASE　APIを利用するための申請をしましょう。BASE APIの利用申請には、BASEのショップアカウントを開設している必要があります。アカウントがない場合は、先にアカウント登録とショップ開設手続きを行ってください。

BASE APIの利用申請は、https://developers.thebase.inから行うことが可能です。

利用申請のURLにアクセスするとBASEのログイン画面が表示されるため、IDとパスワードを入力しましょう。ログイン後、次のようなフォームが表示されます。

BASE API利用申請フォーム

アプリ名とアプリの説明には、BASE APIの用途が分かる内容を記入してください。「商品情報の取得」など、簡単な内容で構いません。

アプリURLとコールバックURLには、BASEで開設したショップのURLなどを記入しておきましょう。アプリのロゴ画像は必須ではありません。

BASE API利用申請フォーム

利用権限は、BASE APIの用途に合わせて、取得したい情報にチェックを入れます。たとえば、商品情報を取得したい場合は「商品情報を見る」にチェックを入れてください。

自分が運営するショップに関する情報の取得が主な用途の場合、「検索APIを利用する」のチェックは不要です。BASE全店舗から検索した情報を活用する場合のみ、「検索APIを利用する」にチェックを入れましょう。

BASE API利用申請フォーム

開発者情報は担当者名、住所、電話番号、メールアドレスが必須項目です。法人名の欄は、個人で利用する場合は空欄のままで構いません。情報の入力がおわったら、「API利用規約に同意する」にチェックを入れ、「申請する」を選択しましょう。

BASE API利用許可の連絡は、登録したメールアドレス宛てに届きます。申請からメールが届くまでの目安は1～2週間です。

STEP2：認可コードを取得する

BASE APIの機能を使用する際には、「認可コード」と呼ばれるコードを取得してください。認可コードは取得から一定期間経つと有効期限が切れるため、使用するたびに取得手続きが必要です。

認可コードは、BASE APIの「/1/oauth/authorize」という機能で取得できます。
具体的な方法は次の通りです。

手順①：許可コードを取得するためのURLを作成する

URLには、自分のBASEアカウントに発行されたクライアントIDや、利用申請時に設定したコールバックURLなどを付与する必要があります。

クライアントIDは、BASE APIの申請を行ったときと同じ「BASE Developers」の管理画面から確認が可能です。「アプリケーション」から「一覧」を選択、アプリの情報画面にある「client_id」の文字列が、クライアントIDとなります。

クライアントIDが「sample1234」、コールバックURLが「https://sample1234.com/callback.php」だった場合、許可コードを取得するためのURLは次の通りです。

https://api.thebase.in/1/oauth/authorize?response_type=code&client_id=sample1234

&redirect_url=https://sample1234.com/callback.php&scope=read_items

URLの末尾にある「scope」のパラメーターは、アプリで設定したスコープに応じて書き換えましょう。今回は商品情報を取得するため、「read_items」をスコープに指定しています。

各パラメーターの設定方法は、BASE APIの公式ドキュメントもあわせて確認してください。

手順②：許可コードを取得するためのURLにアクセスし認証を行う

許可コードを取得するためのURLにアクセスすると、アプリとの連携を許可するための確認画面が表示されます。自身のBASEアカウントでログインを行い、連携を許可しましょう。

手順③：リダイレクトされるURLに付与された認可コードを読み取る

連携を許可すると、以下の例のように、パラメーターとして認可コードが付与されたコールバックURLへ自動的にリダイレクトされます。

上記の「code=」以下に続いている英数字の羅列が、認可コードの文字列です。認可コードは、取得するたびに変化します。

PHPやPythonで認可コードを取得するプログラムを書く際は、許可コードを取得するURLの作成と、リダイレクト後のURLから認可コードの部分を抜き出す機能を実装しましょう。

今回はBASE APIを使用する基本的な流れを紹介するため、各種プログラミング言語を使った具体的なコーディングについては割愛します。

STEP3：アクセストークンを発行する

BASE APIを使って商品情報などを取得する際には、前項で紹介した「認可コード」のほかに、「アクセストークン」と呼ばれる文字列も必要です。

アクセストークンは、認可コードを取得したときと同様の手順で発行できます。ただし、アクセストークンを発行する際は有効期限内の許可コードが必要です。そのため、前項の手順で許可コードを取得した上で、アクセストークンの発行を行いましょう。

また、アクセストークンの発行時には、「クライアントID」と「クライアントシークレット」の2項目も必要です。これらの項目は、「BASE Developers」の管理画面から確認してください。

アクセストークンを発行する具体的な手順は以下の通りです。

手順①：アクセストークンを発行するためのURLにアクセスする

アクセストークンを発行するBASE APIの機能は、「/1/oauth/token」にパラメーターを付与したURLから使用できます。必要なパラメーターは次の5つです。

トークン発行パラメーター一覧

出典：https://docs.thebase.in/docs/api/oauth/access_token

たとえばクライアントIDが「sample1234」、クライアントシークレットが「abcdefg」、認可コードが「56x7y8z9」、アプリに登録したコールバックURLが「https://sample1234.com/callback.php」の場合のアクセストークン発行用URLは次のようになります。

https://api.thebase.in/1/oauth/token?grant_type=authorization_code&client_id=sample1234

&client_secret=abcdefg&code=56x7y8z9

&redirect_url=https://sample1234.com/callback.php

PythonやPHPなどコーディングを行う際は、上記のような各種パラメーターを付与したアクセストークン発行用URLを生成する機能を実装しましょう。

手順②：レスポンスからアクセストークンの文字列を取得する

アクセストークン発行用URLにアクセスすると、次のような文字列がレスポンスとして返されます。

{

“access_token”:”74040c64b51128a492407caba995a285″,

“token_type”:”bearer”,

“expires_in”:3600,

“refresh_token”:”0327ba74dd6b34c47793c870818779bb”

}

「access_token」の行に記載されている文字列が、BASE APIを利用するために必要なアクセストークンです。コーディングを行う際は、取得したレスポンスからaccess_tokenに該当する文字列のみ抽出する機能を実装しましょう。

レスポンスに含まれる各種文字列のうち、アクセストークン以外の意味や役割については、BASE APIの公式ドキュメントもあわせて確認してください。

STEP4：商品情報などを取得する

これまでの手順と同様に、BASEに登録されている商品情報などのデータも、BASE APIのURLにパラメーター付きでアクセスすることにより取得できます。

例えば、商品情報の一覧を取得するための機能は「/1/items」です。付与するパラメーターには、並び替え項目や並び順、商品画像の番号やサイズなどが指定できます。

また、BASE APIの機能を使用する際には、前項で発行したアクセストークンに関する設定も必要です。アクセストークンは、パラメーター部分ではなく、ヘッダーとして含める必要があります。ヘッダーの記述方法は使用するプログラミング言語によって異なるため、実装する際は各言語の記法に従ってください。

各種設定を行い、BASE APIの機能にアクセスすると、JSON形式と呼ばれるテキストデータとしてレスポンスが返ってきます。レスポンスのサンプルデータや、設定できるパラメーターの種類についてはBASE APIの公式ドキュメントもあわせて確認してください。

STEP5：出力された情報を活用する

BASE APIの機能で出力されたテキストデータは、様々な方法で活用することが可能です。

例えば、JSON形式のテキストデータとして出力された商品情報に関するデータをPHPで読み込めば、外部のWebサイトにBASEで販売中の商品を掲載できます。BASEの標準的なショップページではなく、自作のWebサイトでBASEの商品を掲載したい場合などに、BASE APIから出力される情報を活用しましょう。

また、JSON形式のテキストデータを一旦CSV形式に変換すると、商品リストをエクセルで一括管理・編集できるため便利です。JSON形式のテキストデータを扱う具体的なコーディング方法については、各プログラミング言語の公式ドキュメントなどを参考にしてください。