メインコンテンツへスキップ

DX Suite Classic版専用のヘルプセンターです。

本サイトはClassic版に関する記事のみを掲載しております。

APIの基本的な使い方を教えてください。

ここではプログラミングの知識がない方でも、APIによる画像のアップロードとCSVのダウンロードができるまで解説いたします。

以下の説明では各APIを呼び出す際にcurlコマンドを使用します。curlはMac OS XやWindows 10では標準装備されていますが、インストールが必要な際は公式サイトからダウンロードできます。
※ 以下の説明はWindowsでのコマンド プロンプトを例としていますが、Macの場合はターミナルで実行できます。
※ APIの詳細は「DX Suite クラウド API連携説明書」をご参照ください。

画像ファイルのアップロード（OCRの実行）

以下のコマンドでPDFを指定した帳票定義に対してアップロードしてOCRが開始します。太字部分をお客様の環境やファイル名に書き換えて実行します。

curl -X POST -H "X-ConsoleWeb-ApiKey: abcdefghijk" -F "documentId=123456" -F "file=@C:\API\test.pdf" https://company.dx-suite.com/ConsoleWeb/api/v1/reading/pages/add

  • abcdefghijk  はAPIキーとなります。APIキーのコピー方法は「APIキー設定」をご参照ください。太字部分をお客様のAPIキーと差し替えるだけです。

  • 123456 はドキュメントIDとなり、各帳票定義のIDとなります。DX Suite で対象の帳票定義を選択するとブラウザのアドレスバーにdocumentId=xxxxxxと表示されますので、この部分をコピーして太字部分を差し替えます。
    mceclip0.png
  • "file=@C:\API\test.pdf" は、Cドライブ直下のAPIフォルダの中にあるtest.pdfを意味します。例えばデスクトップのSampleフォルダであれば、C:\Users\ユーザ名\Desktop\Sample\test.pdf となります。ファイル名は実際の手元のファイル名に変えていただけます。
    • Macの場合は "file=@/Users/ユーザ名/Desktop/test.pdf " などとパスの指定方法が異なります。
  • 最後の https://company.dx-suite.com/ConsoleWeb/api/v1/reading/pages/add の太字部分をお客様の環境のサブドメインに差し替えます。

  • 上記の各箇所を実際の環境の内容に差し替えて、コマンドプロンプトに貼って実行をすると、以下のように最終行にレスポンスが返ってきます。
    mceclip1.png
    • レスポンスの一番最後の部分の"unitId":11021311は生成された読取ユニットIDです。
    • 実際のDX Suite の画面で該当する帳票に読取ユニットが生成されいることが確認できます。読取ユニットの右側の「・・・」から「属性情報を参照」を選ぶと、読取ユニットIDを確認できます。
      mceclip2.png

CSVファイルのダウンロード

以下のコマンドで読取ユニットを指定してCSVをダウンロードします。太字部分をお客様の環境やファイル名に書き換えて実行します。

curl >C:\API\test.csv -X GET -H "X-ConsoleWeb-ApiKey: abcdefghijk" https://company.dx-suite.com/ConsoleWeb/api/v1/reading/units/123456/export

  • C:\API\test.csv は、Cドライブ直下のAPIフォルダにtest.csvという名前を指定したCSVファイルをダウンロードすることを意味します。例えばデスクトップのSampleフォルダであれば、C:\Users\ユーザ名\Desktop\Sample\test.csv となります。ファイル名は指定したいファイル名に変えていただけます。
    • Macの場合は curl >/Users/ユーザ名/Desktop/test.csv などとパスの指定方法が異なります。

  • abcdefghijk  はAPIキーとなります。APIキーのコピー方法は「APIキー設定」をご参照ください。太字部分をお客様のAPIキーと差し替えるだけです。

  • https://company.dx-suite.com/ConsoleWeb/api/v1/reading/units/123456/export の company の部分をお客様の環境のサブドメインに差し替えます。123456 の部分は読取ユニットIDとなりますのでダウンロードしたい読取ユニットのIDを指定します。
    • DX Suite 画面上の読取ユニットの右側の「・・・」から「属性情報を参照」を選ぶと、読取ユニットIDを確認できます。

  • 上記の各箇所を実際の環境の内容に差し替えて、コマンドプロンプトに貼って実行をすると、以下のように最終行にレスポンスが返ってきて、指定したフォルダにCSVファイルがダウンロードされます。
    mceclip3.png

上記はファイルのアップロード（OCR）とCSVダウンロードをコマンドで実行するシンプルな方法の説明ですが、読取ユニット名を取得するAPIやElastic SorterのAPIなどもありますので、各APIをRPAなどで順番にワークフローに組み込むことで一連の操作の自動化が可能となります。

<関連リンク>

IDはどこで確認できますか？
APIを使って、パラメータにAPIキーをセットしていますが、NewUI の場合も同じAPIキーで良いですか？
New UI のAPIは、従来のAPIと比べて具体的にどう変更されますでしょうか？

関連記事