invoiceAgent Connect for Java API とは
invoiceAgent Connect for Java APIとはinvoiceAgent Connect Pack(有償オプション)に含まれるJavaライブラリで、JavaのユーザーアプリケーションからinvoiceAgent 文書管理のWeb APIを容易に呼び出すことができます。
「invoiceAgent 文書管理のWeb API」については以下の記事をご確認ください。
同様の役割でinvoiceAgent Connect for .NET Framework APIという.NET版のライブラリもあります。
※invoiceAgent Connect for XXはクラウドではご利用いただくことができません
Web APIとinvoiceAgent Connect for Java APIの違い
はじめにお伝えしたいことは、Web APIとinvoiceAgent Connect for Java APIのどちらを使っても実現できることは同じです。
但しWeb APIを直接使うと実装しなければならない処理の多くを、invoiceAgent Connect for Java APIではJavaライブラリとして提供し処理の多くを内部実装しているためユーザーアプリケーション側では大幅に実装を簡略化して記述することができます。
またhttpヘッダ、Cookie、JSON等のパラメータを意識する必要がほとんどなく、Javaライブラリとして提供されるAPIだけを理解すれば実装を行うことができるので学習コストを小さくすることができます。
invoiceAgent Connect Packに含まれるライブラリはJavaと.Netになっているため、PythonやPHP等のその他の言語で利用する場合はご利用いただくことができません。
比較項目 |
Web API |
invoiceAgent Connect for Java API |
invoiceAgent |
オンプレミス,クラウドどちらも利用可 |
オンプレミスのみ |
前提知識 |
Java,HTTP(Cookie含む),JSON,REST API |
Javaのみ |
コーディング量 |
リクエスト、パラメータ、レスポンスといった全ての処理に対してコーディングが必要
|
JavaライブラリのAPIのみでコーディング量が少ない
※Web APIの実装と比べると数分の一
|
言語 |
Java,.Net,Php,Python,他(言語指定なし)
|
Javaのみ(別途.Net版[invoiceAgent Connect for .NET Framework API
]はあり)
|
価格 |
無償(本体のみ) |
有償(invoiceAgent Connect Packに内包) |
invoiceAgent Connect for Java APIの入手方法
invoiceAgent Connect Packのメディアの中に含まれています。
※V10.8.1現在は以下にあります。
${invoiceAgent Connect Packメディア}:\JavaAPI\Lib
ファイル:
lib.win.zip ・・・Windows用
lib.unix.tar.gz ・・・Linux、Unix用
解凍してご利用ください。
解凍するとspaの名称で始まるinvoiceAgent Connect for Java APIのjar形式ライブラリと、jacksonというその内部で利用しているライブラリが展開されます。
spa-common-data.jar
spa-connect-core.jar
spa-connect.jar
spa-ws-data.jar
jackson-annotations-X.X.X.jar
jackson-core-X.X.X.jar
jackson-databind-X.X.X.jar
本記事では手順は説明しませんが、クラスパスにこれらのjarファイルを全て追加してご利用ください。
JavaDoc(API Document)
APIドキュメントのJavaDocはinvoiceAgent Connect Packのメディアの中に含まれます。
V10.8.1現在は以下にあります。
${invoiceAgent Connect Packメディア}:\JavaAPI\Doc
ファイル:
doc.zip
解凍して展開したフォルダにファイル「index.html」があるのでWEBブラウザで開いて確認してください。
またマニュアルについては以下にあるのでこちらもご確認ください。
invoiceAgent Connect Pack ユーザーズガイド
invoiceAgent Connect for Java API
https://cs.wingarc.com/manual/ia/doc/10.10/ja/1092424.html
invoiceAgent Connect for Java APIとは? まとめ
今回の記事ではinvoiceAgent Connect for Java APIの概要と利用のために必要な情報をお伝えしました。
Javaから利用するにはWeb APIの処理が簡単になり実装工数の削減に効果があると思います。
またWeb APIの利用になれていない方でも扱いやすく、学習コストも下げることができるかと思います。
次回の記事では具体的なAPIの利用方法をお伝えいたします。
※本記事の情報は、2023年04月13日現在のものです。(invoiceAgent V10.8.1 / invoiceAgent Cloud Ver.Ver.10.8.1.1302)