API連携

API連携とは、二つ以上のソフトウェアシステムをアプリケーション・プログラミング・インターフェース(API)で接続し、データのやり取りや操作の実行を自動で行えるようにすることです。一方のシステムが構造化されたリクエストを送り、もう一方がデータを返すか変更を確認するため、手作業でのエクスポートやインポートは必要ありません。

システム間の約束事

APIは、あるソフトウェアとやり取りするために公開されたルールの集まりです。どのリクエストが許可されるか、各リクエストに含めるべき情報は何か、応答がどんな形になるかを定めています。双方が同じ約束事に従うため、異なる企業が異なるプログラミング言語で作ったものでも連携できます。

連携とは、その約束事の上に構築された実際のつながりです。どのデータを、どの方向に、どのくらいの頻度で送るか、何かが失敗したときにどうするかを決めます。

リクエスト・レスポンス・イベント

  • 読み取りリクエストはデータを要求します。例えば、ある商品の現在の価格と在庫です。
  • 書き込みリクエストはデータを変更します。例えば、商品に新しい価格を設定します。
  • レスポンスは結果を返します。通常はJSONなどの構造化されたテキスト形式で、成功か失敗かを示すステータスコードが付きます。
  • Webhookは流れが逆です。問い合わせを待つのではなく、新しい注文などのイベントが起きた瞬間に、あるシステムが別のシステムに通知します。

ほとんどのAPIでは認証が必要で、通常は呼び出し元を識別し、実行できる操作を制限するキーやトークンを使います。キーは安全に保管し、連携に必要な権限だけを与えるべきです。

EコマースでAPIが使われる場面

現代のストアは、連携した複数のツールで運営されています。典型的な構成では、ストアのプラットフォームを決済サービス、配送サービス、会計ソフト、マーケットプレイスのチャネル、メールツール、価格ツールとつなぎます。つながり一つひとつが連携であり、それらが合わさって、絶え間ない手入力なしに事業を回し続けます。

価格は、こうしたつながりを流れる値の中でも特に影響の大きいものです。ある場所で設定した価格を、オンラインストア、マーケットプレイスの出品、ショッピング広告用の商品フィードに届ける必要があることもあります。どれか一つの反映が遅れると、顧客は場所によって異なる価格を目にし、広告プラットフォームはフィードの価格がランディングページと一致しない出品を却下することがあります。

価格更新の流れの例

例として、毎朝価格を見直すカメラアクセサリーのショップを考えてみましょう。07:00に価格ツールが120商品の新しい価格を計算します。ツールはストアのプラットフォームのAPIを通じて、商品ごとに、またはAPIが許せばまとめて書き込みリクエストを送ります。ストアは118商品について成功コードを、すでに存在しない2商品についてエラーを返します。ツールがエラーを記録し、スタッフが古い商品を価格リストから削除します。

連携がなければ、誰かが120件の価格を手作業でコピーすることになり、時間がかかるうえ入力ミスの可能性も現実にあります。連携があれば、作業は数分で終わり、すべての変更の記録が残ります。BlackAhaの ストア連携 は、この種の接続を使って、連携したストアに価格を同期します。

API、フィード、手動ファイルの選び方

データを受け渡す方法はAPIだけではありません。スケジュールに沿って公開されるファイルである商品フィードは、一日に数回変わる大規模なカタログに適しています。スプレッドシートのインポートは、一度きりの移行に今でも役立ちます。数分以内に一つの価格を更新し、それが成功したことを確認したいときのように、変更を速く、選択的に、確実に行う必要がある場合はAPIのほうが適しています。

起こりうる問題

  • レート制限:プラットフォームは呼び出し元が一分あたりに送れるリクエスト数に上限を設けているため、一括更新はペースを調整する必要があります。
  • バージョンの変更:提供元は古いAPIバージョンを廃止するため、連携を期限までに更新する必要があります。
  • フィールドの不一致:フィールドの対応づけを誤ると、一方のシステムのセール価格が、もう一方のシステムの通常価格に割り当てられることがあります。
  • 部分的な失敗:一部のリクエストは成功し、ほかは失敗して、データが中途半端に更新されたままになります。
  • 気づかれないエラー:誰にも通知せずに停止した連携は、古い価格を何日も公開したままにしかねません。

これらの大半は二つの対策で防げます。一つ目は、問題を追跡できるよう、すべてのリクエストとレスポンスを記録することです。二つ目は結果を監視することで、例えば更新を実行するたびに、公開中の価格の一部を意図した価格と照合します。

信頼できる連携を計画する

  1. 価格、在庫、商品タイトルなど、フィールドごとにどのシステムを正とするかを決めます。
  2. 通貨、税の設定、バリエーションの識別子も含め、フィールドを慎重に対応づけます。
  3. カタログ全体で有効にする前に、ステージング用のストアや少数の商品でテストします。
  4. 誤った入力が広がらないよう、更新一回あたりの最大価格変動などの制限を設けます。
  5. エラーアラートを受け取り、ログを確認する担当者を決めます。

明確な担当範囲はコードと同じくらい重要です。連携を設定した人が辞めるとき、その連携が何をするのか、どのキーを使うのか、ログがどこに保存されているのかを短く書き残しておけば、次の担当者が推測に費やす手間を大きく減らせます。

要点

  • API連携は、定められたインターフェースを通じてシステムをつなぎ、データを自動でやり取りさせます。
  • Eコマースでは、連携によって価格、在庫、商品、注文がストアとツールの間で受け渡されます。
  • Webhookはイベントを即座に送り出し、APIリクエストは必要に応じてデータを取得・送信します。
  • 最もよくある問題は、レート制限、フィールドの不一致、気づかれない失敗です。
  • フィールドごとに正とするデータ元を決め、まず少数でテストし、更新を実行するたびに監視しましょう。

よくある質問

APIとは何の略ですか?

APIはapplication programming interface(アプリケーション・プログラミング・インターフェース)の略です。あるソフトウェアが別のソフトウェアにデータや操作を要求するための、定められた方法です。

API連携の設定には開発者が必要ですか?

必ずしも必要ではありません。多くのツールには、ログインするかキーを貼り付けて設定を選ぶだけの既製のコネクターがあります。既製のコネクターがないシステム同士を独自に連携するには、通常は開発作業が必要です。

APIとWebhookの違いは何ですか?

API呼び出しでは、あるシステムが任意のタイミングで別のシステムにデータを要求したり変更を送ったりします。Webhookでは、イベントが発生したときに相手のシステムが自動で通知を送ります。多くの連携では両方を使います。

API連携は安全ですか?

キーを非公開にし、権限を必要な範囲に限り、接続を暗号化していれば安全にできます。どの連携がストアにアクセスできるかを見直し、使わなくなったものは削除しましょう。

関連用語

BlackAhaでは、 Store Platform Integration を使えば、ストアを連携して商品価格を自動で同期できます。

価格用語辞典に戻る