intra-mart Accel Platform 外部ソフトウェア接続モジュール 仕様書 第3版 2017-04-01

概要

外部ソフトウェア接続モジュールとは

市販のアプリケーションパッケージから im-BizAPI の各種 API を呼び出して直接利用するなど、intra-mart と外部ソフトウェアを簡単に連携・接続できるモジュールです。
連携・接続する方法には、次の 2 通りの方法が用意されています。
  • この「連携 API コネクタ」を使用して任意のプロセスと im-BizAPI を連携させる方法
  • 外部ソフトウェアから Web サービスにより im-BizAPI の各種 API を呼び出す方法

「連携 API コネクタ」は im-BizAPI と連携するための Java ベース API として提供されているので、外部ソフトウェアが Java 実行環境であれば任意のプロセスと im-BizAPI を連携させることができます。
例えば、市販のポータルサーバ製品と組み合わせて、ポータル画面中に intra-mart の画面を表示したり、他のアプリケーションと連携してバッチ動作する独自の Java プロセスからユーザアカウント情報を操作したりすることが可能です。

コラム

ここでは Webサービスにより im-BizAPI の各種 API を呼び出す方法については説明しません。
「外部ソフトウェア接続モジュール」は互換用として提供されているものです。セキュリティ面での懸念があり、非推奨となっているため利用される場合は十分な注意が必要です。
「Webサービス」については以下のWebサービス各種マニュアルを参照してください。

仕様

外部ソフトウェア接続モジュールのインタフェースは、Java のクラスです。したがって、連携するアプリケーションは、Java インタフェースを利用できることが前提です。
また、Java インタフェースを利用することから、このモジュールが動作する環境には、Java-VM が必要です。

連携用のコネクタクラスは、ネットワークを介して intra-mart Accel Platform と連動します。したがって、ネットワークが利用可能な環境であることも前提条件です。
ただし、API は URL によってネットワーク通信を制御するため、開発者がネットワークを直接意識することはありません。

コネクタは intra-mart Accel Platform に対して、HTTP 接続を行います。連携用に指定する URL には、専用のサーブレットパス(/imart/HTTPActionEventListener(標準))を指定します。
ネットワークは、API に指定されたURL により解決されますが、この URL は intra-mart Accel Platform の運用形態により以下のような注意が必要です。
  • intra-mart Accel Platform がスタンドアロンで運用されている場合は、そのスタンドアロンサーバへの接続 URL を指定します。
  • intra-mart Accel Platform が分散環境で運用されている場合は、Web Server への接続 URL を指定します。

外部ソフトウェア接続モジュールの構成

外部ソフトウェア接続モジュールは、サーバ側モジュールとクライアント側モジュールの2つのモジュールで構成されます。
モジュール名 クラスアーカイブ 説明
外部連携クライアント imaca_client-XXX-main.jar 呼び出し側の外部ソフトウェアに配置するクライアント側ロジックです。
外部連携 認証・認可 imaca_provider-XXX-main.jar intra-mart Accel Platform に配置するサーバ側ロジックです。