外部API公開プラグイン(受注情報) for EC-CUBE 4.1

このプラグインでできること
EC-CUBE 4.1系の受注情報を、外部システムから取得できるJSON APIとして公開できます。
受注一覧APIと受注詳細APIを利用できます。
受注一覧APIでは、受注ID、注文番号、受注ステータス、メールアドレス、注文日、更新日、支払合計などの条件を指定できます。
1ページあたりの件数やページ番号を指定して、ページングしながら受注情報を取得できます。
並び順は、ID、注文日、更新日、支払合計を対象に指定できます。
受注詳細APIでは、指定した受注IDの詳細情報を取得できます。
APIキーによる簡易認証に対応しています。
APIキーは、ヘッダーまたはクエリパラメータで送信できます。
CORSのGETおよびOPTIONSに対応しています。
管理画面から、受注一覧APIと受注詳細APIの有効・無効を切り替えられます。
管理画面にはエンドポイントURLが表示され、コピーして外部システムに設定できます。

導入することで解決できる課題
外部システムと受注情報を連携したい場合に役立ちます。
管理画面から手作業で受注情報を確認したり、必要な情報を転記したりする負担を軽減できます。
受注一覧と受注詳細をAPIで取得できるため、外部システム側で必要な受注データを扱いやすくなります。
APIの有効・無効を管理画面から切り替えられるため、利用状況に応じた運用がしやすくなります。
エンドポイントURLを画面で確認してコピーできるため、外部システムへの設定作業も進めやすくなります。

導入後に得られるメリット
受注データ連携の作業を効率化できます。
外部システムから必要な受注情報を取得できるため、確認作業やデータ連携の手間を減らせます。
APIキー認証により、簡易的なアクセス制御を行えます。
管理画面からAPIの有効・無効を切り替えられるため、運用状況に合わせて利用範囲を調整しやすくなります。
注文番号や受注ステータス、注文日などで絞り込みができるため、外部システム側で目的に合った受注情報を取得しやすくなります。

想定される利用シーン
受注情報を外部の業務システムに連携したい場合に利用できます。
基幹システム、在庫管理システム、出荷管理システム、分析ツールなどへ受注データを渡したい場合に役立ちます。
注文日や更新日を条件にして、一定期間の受注情報を取得したい場合にも利用できます。
受注ステータスを指定して、処理対象の注文だけを外部システムで取得したい場合にも便利です。
受注詳細APIを使うことで、特定の注文情報を外部システムから参照したい場面にも対応できます。

運用時の注意事項
本プラグインは、受注情報をJSON APIとして公開します。
利用前に、APIを有効化する範囲や外部システム側の接続設定を十分に確認してください。
APIキーは第三者に知られないよう、適切に管理してください。
APIキーは管理画面から確認または再発行できます。
受注一覧APIと受注詳細APIは、必要に応じて管理画面から有効化してください。
外部システムに設定する際は、管理画面に表示されるエンドポイントURLを確認してください。
CORSはGETおよびOPTIONSに対応しています。
ご利用に際しては、お客様の環境で十分に動作確認を行った後にご利用ください。

EC-CUBE4.1に対応した受注外部APIプラグイン ver1.0.0 をリリースしました。
EC-CUBEの受注情報を外部システムから取得できるJSON APIとして公開できます。
受注一覧APIと受注詳細APIに対応しています。
APIキーによる簡易認証や、管理画面からのAPI有効・無効切り替えにも対応しています。
外部システムとの受注データ連携を効率化したい店舗運営に役立ちます。