商品情報
外部システムからEC-CUBEの商品一覧・商品詳細を取得できる公開APIを追加します。
APIキー認証や管理画面での有効化設定により、連携作業の効率化と運用負荷の軽減に役立ちます。
商品情報公開APIプラグインは、EC-CUBE4.1環境において、外部システム等から商品情報を取得できる公開APIを提供するプラグインです。
商品一覧を取得するエンドポイント「/np_api/products」と、商品詳細を取得するエンドポイント「/np_api/products/{id}」を利用できます。
外部サービス、社内システム、アプリ、別サイトなどと商品情報を連携したい場合に役立ちます。
APIキー認証機能を備えており、HTTPリクエストヘッダ「x-api-key」またはクエリストリング「?api_key=」による認証に対応しています。
APIキーは管理画面からワンクリックで再発行できます。
不正なアクセスを抑制しながら、必要な外部連携を行いやすくなります。
管理画面の設定画面では、商品一覧APIと商品詳細APIを個別に有効化・無効化できます。
利用しないAPIを停止できるため、運用方針に合わせた管理が可能です。
また、管理画面上で現在のエンドポイントURLとAPIキーを確認し、クリップボードにコピーできます。
外部システムの設定作業や連携確認をスムーズに進められます。
レスポンスに含まれる画像URLは、httpまたはhttpsから始まる絶対URLとして返却されます。
外部システム側で画像を扱う場合にも利用しやすい形式です。
ご利用に際しては、導入前に検証環境等で十分に動作確認を行ってください。
外部公開するAPIの性質上、APIキーの管理、アクセス元、利用範囲を確認したうえで運用してください。
