コラム

他システムとの連携をスムーズに:交換定義を用いたAPI連携

作成者: Admin|2026.05.13

Plaza-i Web APIとは

Web APIとは「HTTPなどのWeb技術を応用して、あるコンピュータで動作しているソフトウェアの機能を、ネットワークを通じて他のコンピュータから利用できるようにする仕組み」を指すことばです。外部のシステムがWebを介して、Plaza-iのデータベースの中にある情報(得意先マスター、受注伝票等)に対して、データを取得する、データを新規登録する等の操作を行えるようにするための窓口の役割を果たします。

外部データ取込、転送と比較したときのAPIによるデータ連携の一番の利点は即時性で、夜間のバッチ処理の終了を待たずともリアルタイムで結果が反映される点が特徴です。Plaza-i Web APIでは得意先マスターや受注伝票等、各データ(リソース)ごとに以下の操作用APIが用意されています。

・データの取得(GET API)
・データの新規登録(POST API)
・既存データの更新(PUT API)
・既存データの削除(DELETE API)

どの操作においても、デスクトップ版のPlaza-iと同様にユーザID、パスワード、さらに当該データへのアクセス権限が求められ、Web APIが実行されるたびにPlaza-iには実行ログが残ります。

データ連携の課題であるシステム間の差異を解消

システム間でデータ連携をする際に乗り越えなければならない大きな課題の1つに、データ形式の差異をどう解消するかが挙げられます。Plaza-iで規定している形式は、例えば得意先コードであればCustomer Codeを縮めてCSTCDと表現します。一方外部システムではcustomer_idなど別の表現が使われることがあり、システム間で仕様が完全に一致していることはありません。

これまではシステム間の差異はPlaza-i の外部で解消する必要がありました。しかし、V2.03.37(2025年2月リリース)以降、Plaza-i 側でマスター設定を行うことで対応できるようになりました。
これにより

  • 外部システムから受け取ったデータをPlaza-i で受け入れ可能な形式に変換する

  • Plaza-i のデータを外部システムでそのまま利用できる形式に変換し転送する

といった処理をPlaza-i Webの機能として行えるようになりました。

外部システムからPlaza-iへデータを登録・更新する場合、受け取ったJSONの項目名をPlaza-i で受け入れられる形に変換します(外部システム→Plaza-i)。逆に外部システムからのリクエストに応じてPlaza-i のデータを返す場合、外部システムが求める形式に変換してデータを返すことが可能になりました(Plaza-i→外部システム)。

本機能は従来の外部データ取込や外部データ転送機能でも利用しているユーザデータ交換処理マスターを利用するため、マスターでサポートしている固定値のセット、値のマッピング機能も利用可能です(式によるデータ変換は未対応です)。

さいごに

本機能は2026年3月時点で、伝票では「受注」「売上」「入出庫依頼」「仕訳」に対応しており、マスターでは「取引先」「得意先」「商品マスター」などに対応しています。

Plaza-iのデータをWeb APIを通じて利活用する際に、マスターの設定でシステム間の差分を解消できる余地が広がったため、導入へのハードルが下がるケースもあるかと思います。Plaza-iの導入をご検討される際、APIのより詳細な説明を聞きたい場合にはお問い合わせください。