この記事でわかること
「EC-CUBEはAPIで外部システムと連携できる」と聞くけれど、そもそもAPIとは何か——この記事では、APIの基礎から、EC-CUBEでAPIを使うと何ができるのか、どう利用するのかまでを解説します。これからEC-CUBEでの外部連携を検討する方向けの、入口となる記事です。
この記事を読むと分かること
- APIとは何か（基礎）
- EC-CUBEのWeb APIでできること
- APIを利用する際に確認したい点
APIとは？
API（Application Programming Interface）とは、ソフトウェア同士が、データや機能をやり取りするための「接続の窓口」です。あるシステムが持つ機能やデータを、別のシステムから利用できるようにする仕組み、と考えると分かりやすいです。
たとえば、天気予報アプリが気象データを表示できるのは、気象サービスがAPIを公開しているためです。アプリは、そのAPIを通じてデータを受け取っています。自分ですべてのデータや機能を用意しなくても、外部のサービスが公開しているAPIを利用することで、その機能を自社のシステムに取り込めます。
APIで、どんなことができるのか
APIを利用すると、外部のサービスと連携して、さまざまなことができます。EC・業務システムの文脈では、次のような用途があります。用途を理解するための代表例を挙げます。
| 用途 | 代表的なサービスの例 | できることの例 |
|---|---|---|
| CRM・顧客管理 | Salesforce など | 顧客情報の連携・管理 |
| 在庫・POS | スマレジ など | 在庫データの同期 |
| データ活用 | Google Sheets API など | データの取得・表計算での活用 |
| 配送 | 配送事業者の提供するAPI など | 送り状作成や配送状況の取得など、提供されている機能に応じた連携 |
| メッセージ・通知 | LINE Messaging API など | 顧客への通知の送信 |
ここに挙げたのは一例です。ほかにも、会計・物流・SNSなど、APIを公開しているサービスは数多くあります。
APIを利用するメリットと、留意点
APIを利用する主なメリットは、外部の機能やデータを、自社のシステムに取り込めることです。
- すでに提供されているAPIを利用することで、一から実装する場合と比べ、工数を抑えられるケースがある
- 外部システムとデータを連携し、手作業を減らせる場合がある
- 複数のシステムを組み合わせて、業務の流れを作れる
一方で、留意したい点もあります。APIを利用すると、外部サービスの仕様変更や、提供停止の影響を受けることがあります。また、連携の設計（認証・エラー処理など）や、公開後の保守も必要になります。メリットだけでなく、こうした点もあわせて検討することが大切です。
EC-CUBEのWeb API
EC-CUBE4系では、外部サービスと連携するための公式のWeb APIプラグインが提供されています。このWeb APIプラグインを利用することで、外部システムとのデータ連携ができます。
公式ドキュメントによると、EC-CUBE4対応のWeb APIプラグインは、次のような仕組みを備えています。
| 仕組み | 内容 |
|---|---|
| OAuth 2.0 | APIクライアントを認可するための仕組み。公式Web APIプラグインでは、Authorization Code Flowに対応 |
| GraphQL | データの取得・更新を行うためのWeb APIの方式 |
| Webhook | 特定のイベントが起きたときに、外部へ通知する仕組み |
| 拡張機構 | 必要に応じて、APIを追加・カスタマイズできる仕組み |
※Web APIプラグインの対応内容・対応バージョンは更新されることがあります。利用の際は、対象のEC-CUBEバージョンに対応する公式ドキュメントと、オーナーズストアの最新情報をご確認ください。
EC-CUBEのWeb APIでできることの例
公式に実装されている機能として、次のようなものがあります。
- 商品情報の取得
- 受注情報の取得
- 顧客（会員）情報の取得
- 商品在庫の更新
- 出荷ステータスの更新
これらを利用することで、たとえば、EC-CUBEの受注・在庫データを外部システムと連携する、といったことができます。標準の機能で足りない場合は、拡張機構を使って、APIを追加・カスタマイズすることも想定されています。
APIを利用するかどうかを、どう考えるか
ここで大切なのは、「APIを使えば、何でも自動化できて効率が上がる」と単純に考えないことです。APIは、外部連携のための有力な手段の一つですが、あらゆる場面で最適とは限りません。
実際のシステム連携では、APIを使うかどうかを先に決めるのではなく、何を・いつ・どちら向きに連携するか、データ量、エラー時の再処理などを整理したうえで、方式を選ぶ必要があります。要件によっては、APIではなく、CSVなどのファイル連携が合っていることもあります。
EC-CUBEと基幹システム・在庫管理などを連携する際の、方式選定と設計の考え方については、EC-CUBEと基幹・在庫システムを連携する方法で詳しく解説しています。基幹連携を具体的に検討している方は、あわせてご覧ください。
EC-CUBEでの外部システム連携を、ご相談ください。
「外部サービスと連携したい」「基幹システムとデータをやり取りしたい」といったご相談に対応しています。EC-CUBEのAPIや、その他の連携方式を含めて、業務に合った方法をご提案します。
よくある質問
APIとは、簡単に言うと何ですか？
ソフトウェア同士が、データや機能をやり取りするための「接続の窓口」です。あるシステムの機能やデータを、別のシステムから利用できるようにする仕組みです。たとえば、外部サービスが公開しているAPIを利用すると、その機能を自社のシステムに取り込むことができます。
EC-CUBE4には、公式のWeb APIプラグインがありますか？
あります。EC-CUBE4系では、公式のWeb APIプラグインを利用することで、外部システムとのデータ連携ができます。OAuth 2.0による認可、GraphQLによるデータの取得・更新、Webhookによる通知などの仕組みを備えています。ただし、対応内容はEC-CUBEのバージョンによって異なる場合があるため、対象バージョンの公式ドキュメントで確認することをおすすめします。
APIを使えば、CSV連携より効率的になりますか？
一概には言えません。APIは外部連携の有力な手段ですが、あらゆる場面で最適とは限りません。連携するデータの内容、必要な頻度、データ量、エラー時の再処理などによって、適した方式は変わります。要件によっては、CSVなどのファイル連携が合っていることもあります。方式を先に決めるのではなく、要件を整理してから選ぶことをおすすめします。
外部サービスと連携する際に、注意することはありますか？
外部サービスのAPIは、仕様や提供条件が変更されることがあります。サービス名や料金体系が変わることもあるため、実際に連携する際は、各サービスの最新の公式ドキュメントを確認することが大切です。また、外部サービスの仕様変更や提供停止の影響を受ける可能性や、連携後の保守方法についても、あわせて整理しておきましょう。
まとめ
APIとは、ソフトウェア同士がデータや機能をやり取りするための接続の窓口です。EC-CUBE4系では、公式のWeb APIプラグインを利用することで、OAuth 2.0による認可のもと、商品・受注・顧客（会員）情報の取得や、在庫・出荷ステータスの更新といった連携ができます。
ただし、APIは外部連携の手段の一つであり、あらゆる場面で最適とは限りません。実際の連携では、要件を整理したうえで、APIやCSVなどの方式を選ぶことが大切です。私たちサンクユーは、EC-CUBEのAPI連携や、基幹システムとの連携に対応しています。外部連携を検討されている方は、お気軽にご相談ください。
投稿者プロフィール
- CEO
- 株式会社サンクユー 代表取締役CEO。
基幹システムとECをつなぎ、受発注業務の最適化を支援する専門家。
関西大学卒業後、東証プライム上場のゼネコンにて人事総務を経験。
その後システムベンダーへ転職し、IBM AS/400環境における金融・物流・販売管理・経理・人事など、企業の基幹業務を支えるシステム開発に従事する。
プログラマからプロジェクトマネージャーまでを経験し、台湾・台北駐在として銀行システム構築プロジェクトにも参画。
この経験を通じて、「システムの質は要件定義の質に比例する」という思想を確立。
業務理解を起点としたシステム設計を強みとする。
その後、クレジット決済代行会社にて、決済システムの再構築や銀行連携、ECサイト構築を担当。
あわせて組織改革にも携わり、20名から60名規模への組織拡大を実現（退任時：常務取締役）。
2008年に株式会社サンクユーを創業、2010年に法人化。
現在は、基幹システムとECの両領域に精通した知見を活かし、BtoB企業における受発注業務のデジタル化・効率化を支援。
特に、FAX・電話・メールなどアナログ業務のEC化や、基幹システムとの連携を前提とした業務設計を得意とする。
単なるECサイト構築にとどまらず、業務フローの整理・要件定義・システム設計まで一貫して関与し、「現場で使われる仕組み」を実現することを重視している。
NTTレゾナント「goo Search Solution」にてEC関連コラムを執筆。
ECマーケティングレポート | goo Search Solution
■趣味・関心領域
BMW / WRC / ロードバイク / RIZIN / UFC / 大相撲
David Bowie / blur / MUSE / The Rolling Stones / XTC
機動戦士ガンダム（富野由悠季）
ベルセルク / 頭文字D / 進撃の巨人 / ジョジョの奇妙な冒険 / あしたのジョー
Mission: Impossible / Memento / ワイルド・スピード / ソナチネ
LOST / Game of Thrones / FRINGE / The Mentalist
上岡龍太郎 / ダウンタウン
