「外部システムとECサイトを連携させるにはAPIがあると便利」なんとなくは理解しているものの詳細はわからない。 そんな企業・店舗のEC担当者であれば、以下のようなことを知りたいはずです。
ECサイトのAPI連携とは?どんなことができる?
ECサイトで使えるのはWeb API?REST API?
ECサイトにAPIを実装する方法は?
そこで本記事では、API連携でできることはなにか?ECサイトで活用されるWeb APIやREST APIを含めた基礎知識・活用のメリットを解説!ECサイトにAPIを実装する方法も紹介 していきます。
※API連携でできることの前に、ECサイトの機能をおさらいしたい方はこちらもご活用ください。
80個のECサイトの機能を徹底調査しました!
D2Cサイトの調査レポート&ECサイト運用の心得
製造から販売まで、仲介業者を挟まずに自社でおこなう「D2C(Direct to consumer)」モデル。日本でもD2Cモデルを採用したブランドが登場し、EC業界に新たな市場をつくりはじめています。
そんな中
・ECサイトをつくりたいけど、どこまでの機能を付ければ良い...
無料でダウンロードする
【無料】おすすめのサービス、ECサイト開発会社を紹介してもらう
ECサイト構築に役立つ記事もご覧ください
ECサイト構築にお悩みならこちら!構築に強い会社や料金相場まとめ
APIの基礎知識を整理
API(Application Programming Interface)とは、プログラム(ソフトウェア)同士を結びつけ、一方の機能をもう一方のプログラムで利用できるようにするためのインターフェース のこと。チャットボットを例に挙げると、チャットボットはテキストや音声の入出力を受け持つ「アプリケーション」と、質問を解釈して返答する「Botシステム」の組み合わせ で成り立っています。アプリで受け付けた質問はAPI経由でシステムに送られ、データベースを参照しながら「ロジック」で解釈・生成された回答が、再びAPI経由でアプリに戻される仕組みです。
macOSは「Core OS」の上層レイヤーにデータ管理・Web接続などの機能をまとめた「Core Services」、マルチメディアの機能をまとめた「Media」が配置され、さらに開発環境を兼ねたAPI「Cocoa」が用意されています。
画像引用:apple
macOSのアプリケーション開発者は、Cocoa(API)をベースに開発することにより、Core Services / Mediaの提供するデータ管理・Web接続・マルチメディア機能などを、アプリケーションに実装することなく利用できる のです。macOSの例では、CocoaがAPIの役割を果たしていますが、独立したアプリケーションであるECサイトが外部システムやWebサービスと連携するには別の方法が必要。これが、APIとのやり取りをhttp / httpsベースで実行するAPIの一種「Web API」です。ECサイトに限らず、外部システムやWebサービスと連携するAPIの多くは「Web API」 であり、単にAPIといった場合はWeb APIを意味する場合がほとんどです。
Web APIの主流はREST / RESTful API
APIにいくつかの種類があるように、Web APIにもいくつかの種類があります。ECサイトを含む現在の主流は、REST(REpresentational State Transfer)の設計原則にもとづいて実装される「REST API / RESTful API」 です。具体的には、「GET(データ取得)」「POST(データ新規作成)」「PUT(データ更新)」「DELETE(データ削除)」などのhttpメソッドを使い、API提供側のデータベースにあるリソース(サービスが提供する情報)に割り振られたURI(識別子)にアクセス します。httpメソッドによるリクエストに対し、データベースは「JSON」「XML」などの形式でデータを返します。
画像引用:HEVO
REST / RESTful APIの基本となる、5つのアーキテクチャ を簡単に紹介しておきましょう。
Decoupling Client Server
クライアントアプリとサーバアプリは独立している必要がある。
クライアントが知り得るのは要求したリソースのURI(識別子)のみ
Stateless
クライアントアプリのリクエストに対し、サーバアプリは
提供した データを保存しない(セッションは1回ごとに完結)
Cashing
リクエストに対するデータをキャッシュすることで、
Statelessの制約を緩和する
Uniform Interface
統一的なインターフェースを定義する
(httpメソッド、データ形式の種類)
Layered System
クライアント / サーバアプリはREST APIを
アプリと異なるレイヤーで 通信する
REST API以外に、SOAP(SimpleObject Access Protocol)APIというWeb APIもあります。httpメソッドやデータのレスポンスに、XMLフォーマットを使う特徴があり、http以外にsmptなどの通信プロトコルにも対応。高度な技能を持つ技術者には好まれますが、XMLのやり取りがやや複雑なため、近年ではあまり採用されることはありません。
【無料】ECサイトのAPI連携について相談する
ECサイトのAPI連携方法
APIが機能を提供するサーバアプリ、機能を利用するクライアントアプリの関係にあること、ECサイトで活用されるAPIのほとんどがREST APIであること が理解できたと思われます。
つまり、ECサイトのAPI連携といった場合は、下記の2つがあります。
ECサイトがAPIを提供するパターン
外部サービスの提供するAPIをECサイトで利用するパターン
ECサイトのAPIを外部システムで利用するパターン
まずは、ECサイトがAPIを提供するサーバアプリになるパターンでできること、システム連携の具体例を紹介します。ECサイトがAPIを提供する場合、外部システムが「GET」「POST」「PUT」「DELETE」の各httpメソッドをリクエストすることで、ECサイトから「顧客情報」「商品情報」「在庫情報」「受注情報」「出荷情報」などのデータをJSON、XML形式で取得 できます。
このようなシステム連携ができる具体例として挙げられる外部システムは以下の通りです。
CRM(顧客管理システム)
在庫管理システム
販売管理システム
倉庫管理システム
受発注管理システム
POSシステム
上記のようなシステムにある顧客情報、商品情報、在庫状況、受注・出荷状況などのデータをシステム連携によって、ECサイト側や連携先システムで確認したり、登録、更新、削除などの作業 ができるようになります。
外部WebサービスのAPIをECサイトで利用するパタ―ン
利用したい外部システム・サービスの提供するAPIにインターネット経由で接続し、ECサイト側から「GET」「POST」「PUT」「DELETE」の各httpメソッドでリクエストして、必要なデータをJSON、XML形式で受け取れます 。
具体例としては、Amazonペイ、楽天ペイなどのID決済をAPI連携で導入する、SNSとAPI連携して口コミをECサイトに表示する、Google Mapのデータを取得するなど、Webサービスとシームレスに連携する方法が考えられる でしょう。とくにAmazonペイなどのID決済が提供しているAPIを使うと、自社ECサイトのユーザーは、Amazon・楽天の自身のアカウントでログインしてそのまま決済できるようになるのです。そのため、ユーザーはECサイトで会員登録をする手間をなくせます。
「ECサイトのAPIを外部システムで利用するパターン」とは逆で、ECサイトが基幹システムのAPIからデータを取得する場合もあります。
画像引用:佐川急便
発送商品の配送ステータス確認や、お届け予定日変更をECサイトとAPI連携できる、佐川急便の「スマートAPI」などを利用し、顧客エンゲージメントを高める方法もある のです。
【無料】ECサイトのAPI連携について相談する
ECサイトでAPI連携するメリット
ここまでの解説で、ECサイトでAPI連携するおおよそのメリットを理解できたはずですが、念のため要点・メリットを整理しておきましょう。
システム連携の開発コスト・期間を抑えられる
macOSアプリの開発者は、COCOA APIを活用することで、OSが提供する機能をアプリに実装することなく利用できることを解説しました。これはECサイトのWeb APIにも当てはまります。 つまり、Web APIを活用することで、ECサイトに必要な機能を実装することなく外部システム・サービスの機能を利用できるため、開発コスト・期間を圧縮できる のです。もちろん、ECサイトの提供するAPIを利用する、基幹システム側の開発コスト・期間を圧縮できる効果も得られます。
比較的容易に実装・システム連携できる
システムを連携する際、基本的には連携させるシステム同士のプログラミング言語や開発環境に合わせて実装・連携させる必要があります。すると、必然的にその言語や開発環境の知識・経験があるエンジニア・プログラマーでないと作業が難しいものです。
しかし、たとえばREST APIの場合「httpメソッドやJSON・XMLデータ形式」などの仕様さえ共通化しておけば、ECサイト本体にカスタマイズを加える必要はありません 。連携させるシステムごとのプログラミング言語も意識する必要もなく、連携ができます。
【無料】ECサイトのAPI連携について相談する
ECサイトにAPIを実装する方法
それでは、ECサイトにAPIを実装するには、具体的にどうすればいいのでしょうか?ECサイトの構築方法、利用するサービス・プラットフォームによって違いはありますが、一般的なAPI実装方法を簡単に解説 していきます。
外部WebサービスのAPIをECサイトで利用する場合は2通り
おおむね以下のような手順を踏んでAPIの実装 を進めていきます。
外部WebサービスにAPIの利用を申し込む(利用登録)
「APIキー」「シークレットキー」を取得する
外部Webサービスのリファレンスに従ってAPIを実装する
セキュリティの観点からも、提供側が何の制約もなくAPIを利用させることはありません 。アカウントIDに該当するAPIキー、パスワードに該当するシークレットキーが必要になるのはこのためです。
プラグイン・オプションを利用
画像引用:EC-CUBE
ECサイトでAPIを利用するには、APIインターフェースを実装する必要があります。最も簡単な実装方法は、ベンダーやサードパーティのプラグインを利用する、ベンダーのオプションを利用 することです。たとえば、国内で最も利用されているオープンソースのECサイト構築CMS「EC-CUBE」であれば、無償で「EC-CUBE Web APIプラグイン」をダウンロード可能。プラグインによるAPI機能拡張により、EC-CUBEをサーバアプリとし、クライアントアプリへAPIを提供することもできます。EC-CUBEのAPIにて、外部システムからEC-CUBEでの会員に直接メッセージを送信することもできる のです。
APIインターフェースを開発
利用しているECサイトでプラグイン・オプションが使えない場合、APIインターフェースを別途開発 していくことになります。上述したように、APIインターフェースはECサイトそのものをカスタマイズするわけではありません。そのため、リファレンスに従って作業を進めていくことで比較的容易に実装可能 です。
【無料】ECサイトのAPI連携について相談する
ECサイトのAPI連携の注意点
便利になるAPI連携ですが、もちろん注意点・デメリットもあります。あらかじめ知っておかないと想定外のトラブルに遭う恐れがあるので、おさえておきましょう。
連携先のサーバー障害のリスクは常にある
API連携とは、連携先の企業のサーバーを通じて行えます。連携中に連携先の企業のサーバーに障害などトラブルが生じると、API連携によるデータ取得ができない恐れ があります。 すると、自社ECサイト側で本来提供できるはずのサービスが利用できなくなり、最悪の場合はECサイト自体が停止してしまう可能性もあります。サイトのユーザーにも不便を感じさせたり、「個人情報の管理は大丈夫なのか?」と不安を感じさせる恐れがあるのです。
対策としては、連携先のサーバー障害時に備えて、代替の運用法を決めておいたり、BCP(事業継続計画)の策定 をしておきましょう。
連携先のサービス変更で自社サイトに不具合が生じる恐れがある
連携先の都合によって、連携先のAPI提供が停止されたり、連携先のサービスの仕様変更などによって、自社サイトにも何らかの不具合が生じる可能性はゼロではありません。その場合、連携方法そのものを抜本的に変更する必要 が生じます。
対策としては、連携先と良好なコミュニケーションをとっておき、すぐに相談できるようにしておくような関係を築いておきましょう。また、連携先との役割分担や責任の所在を明らかにしておくといいです。トラブル発生時の報告先、想定トラブルごとにどちらがどこまで対応するかを決めておきましょう 。
【無料】ECサイトのAPI連携について相談する
ECサイトAPIまとめ
「なんとなくの概要は理解しているけど、APIの詳細はわからない」という方に向け、本記事では、APIとはなにか?API連携でできることはなにか?ECサイトで活用されるWeb APIやREST APIを含めた基礎知識・活用のメリットを解説しました。また、ECサイトにAPIを実装する方法も紹介してきました。比較的シンプルな仕組みを持つWeb APIは、ECサイトの機能を拡張して使い勝手を向上させるのに非常に有効 です。ただし、主流となるREST APIには「厳密な仕様が決められていない」一面があり、容易とはいえITの知識・スキルに乏しい方では実装が難しいのも事実。実装に不安があれば、ECサイト開発会社に相談するのがおすすめ です。
コンサルタントのご紹介
代表取締役 岩田 真
2015年にWeb制作会社を設立し、
3年間で上場企業を含む50社以上 制作に携わらせていただきました。
ホームページ制作のオンライン相談窓口「Web幹事」は、35,000件を超える豊富な相談実績 と幅広い知識で、お客様のあらゆるニーズにお応えします。
Web制作業界のプロが丁寧にヒアリングしますので、
初心者の方でも安心してご相談ください!
※API連携できるECサイトを構築したいがサービス/ ツールの選び方がわからない、あるいはECサイトへのAPI実装に不安がある方は、Web幹事にご相談ください。 専任のアドバイザーが最適なサービスや開発会社をご紹介します。相談料などは一切かかりませんので、お気軽にお問い合わせください。
【無料】おすすめのサービス、ECサイト開発会社を紹介してもらう
Q.
ECサイトでAPI連携する方法は?
「ECサイトのAPIを外部システムで利用する」「外部WebサービスのAPIをECサイトで利用する」の2つの方法があります。
Q.
ECサイトでAPI連携を始める際の注意点は?
ECサイトでAPI連携を始める際の注意点として「連携先のサーバーに障害が発生すると、データ取得ができない恐れがある」「連携先の仕様変更によって、自社サイトに何らかの不具合が生じる場合がある」等が挙げられます。詳しくは記事をご覧ください。
Q.
ECサイトで使われるAPIの種類は何ですか?
ECサイトでよく使われるAPIの種類は、Web APIとREST APIです。Web APIはhttp / httpsベースで通信し、外部システムやWebサービスとデータをやり取りします。REST APIはRESTの設計原則に従って実装され、httpメソッドを使ってデータの取得や更新を行います。