【DX121】APIの基本的な使い方について~前編~
こんにちは、NTTデータ技術支援チームです。
いつもユーザーフォーラムをご利用いただき、ありがとうございます。
今回は、APIでのDX Suiteの利用について前後編に分けてご案内いたします。
■ APIとは?
APIとは、ソフトウェアの機能を外部システムから実行する仕組みのことです。
API を使用すると、異なるソフトウェアとDX Suiteが連携され、
画像ファイルアップロードからCSVダウンロードまで一連の処理を自動化することができます。
例)APIを利用し、DX Suiteで読み取りからCSVダウンロードまで実行する場合
1.読取ユニットの作成(帳票のアップロード)
「読取ユニット登録」APIを利用し、読み取り対象のファイルをアップロードする処理を実行します。
2.読取ユニットのステータス確認
「読取ユニット検索」APIを利用し、上記で登録した読取ユニットがCSVダウンロード可能な状態かを確認します。
3.CSVダウンロード
「CSVダウンロード」APIを利用し、登録した読取ユニットからCSVファイルをダウンロードする処理を実行します。
4.(必要に応じて)読取ユニットの削除
CSVダウンロード直後、直ちに削除したい場合などは「読取ユニット削除」APIを利用することで、
指定した読取ユニットを削除することが可能です。
上記のようにAPI を利用すると、DX Suite と外部ツールを連携し、一連の処理を自動化することができます。
■ API ご利用時の注意事項
API のコマンドの組み方を間違えると機能しない場合があります。
AI inside社のヘルプセンターに掲載されているAPI仕様書にてご確認をお願いいたします。
API 仕様書・開発者向けドキュメント
以上、ご参考になれば幸いです。
<本投稿の動作環境>
DX Suite(クラウド版)v1.147.0
<お願い>
本投稿に関しての問合せにつきましては、
恐れ入りますがコメントではなく、個別問合せにてお願いいたします。