Search
Search
Category
invoiceAgentと他のシステムを連携したい、invoiceAgentで行っている業務を自動化したいといった際にはWeb APIを利用して実現することができます。
以下のようなケースです。
invoiceAgentにPDFを投入するという意味では電子帳簿保存法対応での用途であったり、invoiceAgentのデータを外部システムで活用という意味ではAI OCRでテキストにしたデータの活用等が多いのではないかと思います。
本まとめでは「こんな要件には解説記事はコレを見ればOK」といった逆引き形式で各記事へのリンクをご紹介します。
Web APIの利用はシステム開発を伴うため対応工数が必要になりますし、その後の維持メンテナンス等も必要になります。
そのようなコストがなるべく掛からないよう、まずは「そもそもinvoiceAgentの標準機能だけで実現できないか?」を事前によくご検討/ご確認ください。
例えば外部システムで添付したファイルをinvoiceAgentに保管したいといった要件の場合、外部システムで特定のフォルダーへ連携対象のファイル出力することでinvoiceAgentのBridgeサービスで監視して連携/保管の要件を満たすことができます。この場合はもちろんWeb APIを利用した開発は不要になります。
但し外部システムとの連携で「即時性」が必要であったり、何かしらの「条件分岐」が必要であったり、invoiceAgentに保管した際の「IDやURLリンクを外部システムへ保存する」必要がある場合はinvoiceAgentの標準機能だけで実現することが難しく、やはりWeb APIの利用が必要になります。
繰り返しになりますがWeb APIの利用はよく要件を確認の上、ご検討ください。
Web APIの利用にあたっては必ずマニュアルをご確認ください。
記事中の情報はタイミングにより情報が古かったり、情報を分かりやすく伝えるため個別のケースにおける情報を省略して記載している場合があります。
invoiceAgent Cloudマニュアル
https://help.spa-cloud.com/ja/index.html
invoiceAgent(オンプレ版)マニュアル
https://cs.wingarc.com/ja/manual?brand=ia_o
Web APIの利用にあたってユーザー認証とその後のセッション管理は必須で実装いただく必要があります。
まずはこの記事でinvoiceAgentのログインとセッション管理について実装方法をご確認ください。
HTTPプロトコルについての知識が必要ですが、HTTPヘッダやCookieの内容について可能な限り見える形で説明を行っておりますので、あまり詳しくないといった方にも処理をイメージしやすくなっています。
記事:
単に画面からPDFファイルをアップロードしたり、Bridgeサービスで取り込むことでは事足りない自動化の要件があった場合にWeb APIを使用してアーカイブすることでさまざまな要件に対応することができます。
例えば外部システムに添付されたPDFをinvoiceAgentへ保管して、プレビューURLを保存してリンクさせたいといったケースです。
記事:
アーカイブ処理の基本やシンプルな実装方法は「invoiceAgentのWeb APIを使ってみる2 ファイルの保存/アーカイブ」をご確認ください。
外部システムからinvoiceAgentへ保管したファイルのプレビュー画面へ遷移させたい場合は、「invoiceAgentのWeb APIを使ってみる4 保存/アーカイブ時にプレビューURLを取得」をご確認ください。アーカイブ時のレスポンスからプレビューURLを取得する方法について説明しています。
保存済みPDFに取引先、取引日付、取引金額の情報を付与して検索できるようにしておくことで電子帳簿保存法の要件へ対応したい等の、カスタムプロパティへ値をセットすることで検索要件に対応したいケースに参考にいただける記事です。
カスタムプロパティにセットしたい値をJSONに詰めて、リクエストを送信する方法について説明しています。
特定の顧客や取引日付といった業務要件や、アーカイブした日付や確認済みとなっているか等のプロパティ条件で検索したいニーズは多くあるかと思います。
記事:
検索条件をJSON形式で送り検索を実行、レスポンスのJSONから結果を取得するといった実装方法を解説しています。
検索条件が複雑になっても応用の効く実装方法になります。
invoiceAgentに保管しておいたファイルを外部システムで活用したい、送信したい場合はWeb APIよりファイルを取得して実装することができます。
記事:
ドキュメントIDをキーにファイルのダウンロード処理を実装する方法、レスポンスヘッダからファイル名を取得する実装方法について説明しています。
invoiceAgentのAI OCRを使用してデータ化した情報をCSVファイルに出力してダウンロードし2次活用いただくことができます。
記事:
CSVファイルの生成リクエストを送信しますが生成処理は非同期で実行されるので、完了するまで待機処理と生成ステータスのチェック処理が必要になります。
少しボリュームのある記事ですが利用するAPIの難易度は低めなので理解のしやすい記事になっています。
ウイングアーク1stのエンジニアによるPower Automate DesktopとinvoiceAgent の連携に関する解説記事です。
通常はWeb APIを利用するにはプログラミングが必要になりますが、この記事ではノンプログラミングで連携を実現しています。
ENGINEER TECH BLOG
ウイングアーク1stのエンジニアによるテックブログ
いかがだったでしょうか?
各記事の末尾には必ずサンプルソースファイルのダウンロードがあるので、まずは記事を読んだ上でダウンロードいただき、動かしていただくのがご理解いただく最短の方法かもしれません。
invoiceAgentのWeb APIは各記事で紹介したものはほんの一部で、その他に多数ご利用いただくことができます。
Web APIの利用にはパターンがあるので、これまでご紹介した記事を読んでいただいていれば一通りのパターンはご理解いただけます。
そのため他のWeb APIを利用する際にもマニュアルさえ見ていただければ似たパターンを思い出していただけるので、概ねスムーズにご利用いただけるかと思います。
ぜひWeb APIを利用してアイディアを形にし、さまざまな業務要件への対応や業務効率化/自動化に取り組んでみてください。
Related article
Pick up
Ranking
Info
