API
BASEでネットショップを開いているが、APIを使ってもっと効率化していきたい。 どんなことができるのか気になる。と思ったことはないでしょうか。
本記事では、BASE APIでできることやネットショップサービスへの申請・連携方法を詳しく解説していきます。
BASEを利用中の方はもちろん、今後利用するか迷っている方もぜひ参考にしてみてください。
独立行政法人国立高等専門学校機構卒業。情報・通信サービス企業に就職。現在、副業WEBライターとして2年以上活動中。将来の夢は猫と一緒に生活すること。好きな言葉は【自分は『変わった』のではなく『変えたのだ』】
BASE APIとは何か？
出典：BASE
そもそもAPIとは、アプリケーション・プログラミング・インターフェース(Application Programming Interface)の略称で、
アプリケーション同士を繋げる橋のような仕組みのことをいいます。
他サービスとデータを共有する仕組みであるBASE APIを活用すると、BASE上の商品情報や注文情報などのデータを取得して連携できます。この仕組みを活用することにより、機能を拡張できたり業務の効率化にも繋がります。
また、BASE APIはショップオーナーであれば無料で利用できます。
BASE APIでできること・活用方法
BASE APIの機能概要
BASE APIの機能としては、大きく分けて3つあります。
-
- BASEで販売している商品を外部のサイトに載せることができる
- 商品データを一括で編集できる
- BASE Appsをカスタマイズできる
それぞれについて解説します。
BASEで販売している商品を外部のサイトに載せることができる
出典：BASE
BASE APIで商品情報を読み込むことにより、自社サイトやブログにBASEの商品を掲載できます。もちろん、購入もできます。BASE上でのショップ運用であれば、デザインなどは指定のテンプレートに沿ったものになります。
しかし、BASE APIを使用することによってデザインや機能を自由にカスタマイズできます。
商品データを一括で編集できる
引用：BASE
BASEの管理画面では、出品している商品の編集や削除などを一括で操作できません。CSVファイルを利用すれば一括で出品できますが、設定できる商品画像の数が決まっているなどの制限があります。商品があまり多くなければ問題はないのですが、中には数多くの商品をBASEで出品しこの作業が手間だと感じる方もいると思います。
そこでBASE APIには、商品情報などを一括で編集する機能が用意されています。そのため、ひとつずつ編集するよりも業務の効率化が期待されます。
BASE Appsをカスタマイズできる
出典：BASE
BASE Appsとは、より充実した設定を追加したり、新しい機能を追加できる機能です。例えば、クーポン発行機能やメッセージ機能、オリジナルデザインのマグカップやケース作成機能などがあります。
また、クラウドサービスとも連携ができます。
商品や注文、顧客、決済情報の取得・更新
通常の管理画面からだと出品している商品情報や注文情報を一括で取得や更新することができません。BASE APIを活用することによって、商品や顧客情報を一括で取得したり更新することができます。
BASE APIを使用することで、在庫管理の効率化や、注文処理の自動化が可能になり、ショップ運営をスムーズに行えます。
外部サイトとの連携
自社サイトやブログと連携させることによって、よりカスタマイズ性の高いショップを開くことができます。例えば、外部のマーケティングツールや在庫管理システムと連携させることで、情報の一元管理やデータの自動連携が可能になります。
BASE APIで外部サイトとの連携することにより、自社のブランディングやイメージを明確に伝えることができ、商品のアピールも効果的にすることができます。
自動化・効率化
BASE APIには、商品情報などを一括で編集する機能が用意されています。そのため、出品業務の効率化が実現できます。
また、BASE APIをクラウドサービスと連携させることによって、会計処理なども効率化させることもできます。
データ分析・マーケティング
BASE APIとGoogleAnalyticsとの連携させることによって、ショップサイトのデータ分析を行えます。APIから取得したデータを分析することにより、効果的なマーケティング戦略を立てたり、商品ラインナップの見直しなどに活用できます。
また、ネットショップ内のユーザーの動きやページごとの平均滞在時間などより詳しく分析することも可能です。
BASE APIの使い方
では、実際にBASE APIを利用したい場合どうしたらいいのか。申請手順と連携方法をお伝えします。画像を使いながら詳しく説明していくので、申請するときの参考にしてみてください。
ステップ1. BASEのショップを開設
まずは、BASEのショップを開設していない方は開設しましょう。
メールアドレス・パスワード・ショップURLを入力するだけで、無料で開設することができます。
ステップ2. BASE APIの利用申請
ショップを開設できたら、BASE Developersへアクセスし、左下の「申請する」をクリックします。
クリックするとこのような画面に遷移します。ここからアプリ情報と開発者情報を入力していきます。
| 必須項目 | 入力内容 |
| アプリ名・ アプリの説明 |
BASE APIの用途内容 例：商品情報の取得 |
| アプリURL・ コールバックURL |
BASEで開設した ショップのURLなど |
アプリのロゴ画像は必須項目ではありません。
利用権限については用途に合わせて、取得したい情報にチェックを入れます。
例：商品情報を取得したい場合は、「商品情報を見る」にチェック
次に、開発者情報を入力していきます。
| 必須項目 |
| 担当者名 |
| 住所 |
| 電話番号 |
| メールアドレス |
法人名の欄については個人で利用する場合、空欄のままで大丈夫です。全ての入力が終わったら、最後に「API利用規約に同意する」にチェックを入れ、「申請する」をクリックします。
申請後、API利用許可が下りればメールが届きます。おおよそ1～2週間で届きます。
ステップ3. 認可コードを取得する
メールが届けば、次は認可コードといったコードを取得していきます。認可コードには有効期限があり一定期間で切れるため、定期的に取得手続きが必要になってきます。
取得方法は、BASE APIの/1/oauth/authorizeという機能から取得できます。
詳しい手順は以下の通りです。
手順1. 許可コードを取得するためのURLを作成
URLを作成するには、自身のBASEのアカウントに発行されたクライアントIDや、利用申請時のコールバックURLなどを入力する必要があります。
・クライアントIDの確認方法
BASE APIの申請を行う時にアクセスした、BASE Developersの管理画面から確認できます。
具体的な操作は、アプリケーションから一覧を選択し、アプリの情報画面にあるclient_idに記載された項目が、クライアントIDになります。
・取得URLの例
クライアントIDが「Jitera46」、コールバックURLが「https://Jitera46.com/callback.php」の場合だとURLは以下のようになります。
| https://api.thebase.in/1/oauth/authorize?response_type=code&client_id=Jitera46&redirect_url=https://Jitera46.com/callback.php&scope=read_items |
URLの末尾にあるscopeについては、アプリで設定したスコープに応じて書き換えます。
| スコープ名 | 内容 |
| read_users | ショップ情報 取得(デフォルトで付与) |
| read_users_mail | ショップのメールアドレス取得 |
| read_items | 商品情報取得 |
| read_orders | 注文情報取得 |
| read_savings | 振込申請情報取得 |
| write_items | 商品情報を更新 |
| write_orders | 注文情報を更新 |
手順2. URLにアクセスし認証を行う
許可コードを取得するためのURLにアクセスすると、アプリ連携を許可する確認画面が表示されます。自身のBASEアカウントでログインを行い、連携を許可します。
手順3.付与された認可コードを読み取る
連携を許可すると、パラメーターとして認可コードが付与された以下のようなコールバックURLへ自動的にリダイレクトされます。
| https://Jitera46.com/callback.php?code=3261cb43d7b3d7f4af218eff80ceba8b |
リダイレクトされたら、URL内の認可コードcode=以下の英数字の羅列を読み取ります。ちなみに認可コードは、取得するたびに変化します。
またPHPやPythonで認可コードを取得するプログラムを書く場合には、許可コードを取得するURLの作成・リダイレクト後のURLから認可コードの部分を抜き出す機能を実装します。
ステップ4. アクセストークンを発行する
BASE APIを使って商品情報などを取得するときには、アクセストークンといった文字列も必要になってきます。
アクセストークンは、認可コード取得したときと同じような手順で発行できます。ただし、アクセストークンを発行する際は有効期限が切れていない許可コードが必要になります。そのため、許可コードを取得した状態で、アクセストークンの発行を行いましょう。
また、アクセストークンの発行時には、BASE Developersの管理画面から確認できる、クライアントIDとクライアントシークレットも必要になります。
詳しい手順は以下の通りです。
手順1. アクセストークンを発行するためのURLにアクセス
アクセストークンを発行する機能は、/1/oauth/tokenに必要な5つのパラメーターを付与したURLから使用できます。
| パラメーター名 | 内容 |
| grant_type | authorization_code |
| client_id | クライアントID |
| client_secret | クライアントシークレット |
| code | 認可コード |
| redirect_uri | 登録したコールバックURL |
発行用URLの例
クライアントID「Jitera46」、コールバックURL「https://Jitera46.com/callback.php」、クライアントシークレット「xytea」、認可コード「6x87xy2z」の場合URLは以下のようになります。
| https://api.thebase.in/1/oauth/token?grant_type=authorization_code&client_id=Jitera46&client_secret=xytea&code=6x87xy2z&redirect_url=https://Jitera46.com/callback.php |
手順2. レスポンスからアクセストークンの文字列を取得
アクセストークン発行用URLへアクセスすると、以下のような文字列がレスポンスとして返されます。
{
“access_token”:”74040c64b51828a492407caba995a285″,
“token_type”:”bearer”,
“expires_in”:3600,
“refresh_token”:”1367ba96dd6b37c45379c870985617bb”
}
各文字列の内容については、以下の通りです。
| 文字列 | 内容 |
| access_token | APIにアクセスするために必要なトークン。 有効期限は1時間 |
| token_type | bearer |
| expires_in | アクセストークンの有効期限 |
| refresh_token | アクセストークンを再発行するために必要なトークン。有効期限は30日 |
BASE APIを利用するために必要なアクセストークンは、access_tokenに記載されている文字列です。
また、コーディングを行う際には、レスポンス取得したときにaccess_tokenに該当する文字列のみ抽出する機能を実装してください。
商品情報を取得
BASEに登録されている商品情報などのデータも、これまで解説してきた同じ方法で取得できます。
商品ごとに取得させる方法
商品ごとに情報を取得する場合は、GET /1/itemsを使います。また、リクエストパラメーターによって、並び替え項目や並び順、商品画像の番号やサイズなどを指定できます。
| 項目 | 内容 |
|---|---|
| visible | 公開ステータス 1:表示、0:非表示 |
| order | 並び替え項目。list_order、created、modifiedのいずれか (デフォルト: list_order) |
| sort | 並び順。asc か desc のいずれか (デフォルト: asc) |
| limit | リミット (デフォルト: 20, MAX: 100) |
| offset | オフセット (デフォルト: 0) |
| max_image_no | 画像番号 1~20 (デフォルト: 5) |
| image_size | 画像サイズ。origin、76、146、300、500、640、sp_480、sp_640からカンマ区切りで複数指定 (デフォルト: origin) |
| category_id | カテゴリID (デフォルト: 指定なし) |
カテゴリやブランドごとに取得させる方法
カテゴリやブランドごとに取得する場合は、GET /1/categoriesを使います。BASE APIを利用すると、特定のカテゴリやブランドに属する商品の情報を一括で取得することが可能です。
この機能は、ショップが扱う商品の中から特定のカテゴリやブランドの商品だけを抽出したい場合に便利です。
特定の商品のみ取得させる方法
カテゴリやブランドごとに取得する場合は、GET /1/items/detail/:item_idを使います。各種設定をし、BASE APIの機能にアクセスすると、JSON形式※1といったテキストデータとしてレスポンスが返ってきます。
レスポンスのサンプルデータや、他にも設定できるパラメーターがBASE API公式ドキュメントに記載されているので、合わせて確認してみてください。
※1 JSON形式とは「JavaScript Object Notification」の略称。JavaScriptで値を取り扱うためのドキュメント規格のこと。
出力された情報を活用
BASE APIで出力されたテキストデータは、色々な方法で活用することができます。
例えば便利な活用方法として、JSON形式で出力されたテキストデータを一旦CSV形式に変換すると、商品リストをエクセルで一括管理や編集が可能になります。
また、JSON形式で出力された商品情報に関するテキストデータをPHP※2で読み込めば、自社サイトやブログなどの外部サイトにBASEで販売中の商品を載せることもできます。
※2 PHPとは「Hypertext Preprocessor」の略称。動的にWebページを生成することができるサーバーサイドのスクリプト言語のこと。
BASE APIの導入事例
実際にBASE APIを活用した事例を３つ紹介していきます。
1.会計ソフトfreeeとの連携
freeeとBASEを連携させることによって、ショップデータの読み込みを自動で行います。
ネットショップでは、入金や手数料、注文のキャンセルなど処理すべき会計情報が多くなっています。全て手作業で記帳を行うと手間がかかってしまったり、ミスが発生したりとどうしても時間がかかってしまいます。
そこでfreeeとBASE連携させることによって、売上高はもちろん、ネットショップで必ず発生する決済手数料や送料などの細かな情報まで自動で読み込むことができ業務効率が図れます。
2.Ameba Ownedでのネットショップ作成
Ameba OwnedはWebサイトの制作サービスで、ブログ感覚でデザイン性の高いウェブサイトを作ることができます。BASE連携機能を使うと、自作のWebサイトにEC機能を追加することができるので、自身のWebサイトでBASEに出品した商品を販売できます。
また、Ameba Ownedの管理画面上から商品登録や売上の確認ができる点でも業務効率が図れます。
3.BASE DESIGN MARKETでのネットショップ作成
BASE DESIGN MARKETはクリエイターが作成したテンプレートが販売されているサイトです。こちらはネットショップオーナーではなく開発者向けになってしまいますが、HTML編集を活用しオリジナルのテンプレートを作成、BASE DESIGN MARKETで販売できます。
BASE API導入の注意点
ここまでBASE APIの機能や申請方法などをお伝えしてきました。便利で業務効率を図れる機能だと知っていただき導入しようと感じられたのではないでしょうか。
しかし注意すべき点もあるので、詳しく解説していきます。
APIの利用回数に制限がある
BASE APIの利用回数には制限があります。利用回数の上限が1時間あたり最大5,000回、1日あたり最大10万回になります。
イメージとしては、csvデータを利用し商品の一括編集を行おうとしたとします。そのcsvに書き込まれている1行がAPIの利用1回になります。なので、1時間以内に5,000行を超える処理を行おうとすると制限がかかり、エラーが出てしまいます。
しかし、開発するアプリの用途やユーザー数によっては、制限がすぐにかかる場合もあるかと思います。利用回数の上限を緩和する必要がある場合は、1度BASEに問い合わせし緩和依頼をしてみてください。
WordPressプラグインは限定的な機能のみ
WordPressのプラグインである、BASE商品リストはBASE APIに含まれる機能の一部です。商品リスト以外の機能を利用したい場合は、PHPやPythonなどでコーディングを行う必要があります。
セキュリティ対策を徹底する
APIは自動処理で便利な機能ではありますが、その分セキュリティリスクの大きい技術ともいえます。もし認証情報が漏れると、データの一斉削除やプライバシーや機密に関わるデータが抜かれてしまうなどのリスクがあります。
このようなリスクを避けるためにもセキュリティ対策を徹底する必要があります。
必要な権限を確認する
セキュリティ対策の1つとして権限を設定することも効果的です。お金の管理や顧客管理などの機密性の高いメニューへのアクセス権限を制限することができるので、確認しておきましょう。
テスト環境で動作確認を行う
BASEではテストをおこなう専用の環境がなく、その代わりにショップを一般公開せず、パスワードを知っている人のみ閲覧できるシークレットEC機能があります。
いきなり本番環境で行ってしまうと、思わぬエラーなどが発生した時に大変です。そのため、テスト環境で動作確認を行ってから本番環境でBASE APIを使っていきましょう。
まとめ：BASE APIを活用してビジネスを強化させよう
いかがでしょうか。今回は、BASE APIの機能や申請方法などを解説していきました。BASE APIを活用することで、オンラインショップの運営を効率化し、ビジネスを強化することができます。自動化や外部システムとの連携、データ分析など、APIを駆使して高度な運営が可能になります。
今後、このようなAPI連携を活用したビジネスが増えてくると予想されます。API連携をもっと活用させていきたいなどと感じられましたら、ぜひ株式会社Jiteraへお気軽にご相談ください。
