DX Suite 全文読取API V2 共通仕様ガイド

DX Suite 全文読取API V2 全体に共通する仕様について説明します。

(１) インターフェース仕様

項目	説明
リクエストホスト	https://{組織固有}.dx-suite.com/wf/api/fullocr/v2/ 各API仕様のURIを参照ください。
プロトコル	HTTPS
レスポンスデータ形式	application/json
文字コード	リクエスト・レスポンスともに UTF-8 です。
レスポンスステータスコード	リクエストが成功したら、処理結果に関わらず200 を返信します。処理結果はJSON内のstatus値を確認してください。処理前にエラーが発生した場合は4xx/5xxのステータスコードを返信します。
認証	APIを呼び出すためにはDX Suite の「設定 > APIキー設定」で発行したAPIキーが必要です。 APIキーはapikeyヘッダで付与します。［注意］APIキーはセキュリティ上重要な情報であるため、第三者に知られないよう十分にご注意ください。
リクエストヘッダ	"x-forward-for"ヘッダが空の場合リクエストに失敗します。

※Windows環境でcurlコマンドをご利用になる場合、ファイル名等にマルチバイト文字(全角文字等)が含まれていると文字コードの影響で正常に処理ができません。

全文読取APIの実行時にエラーが発生した場合は、以下のレスポンス構造のJSON形式の文字列で返されます。

エラーレスポンスの例:利用できないAPIキーを指定した場合

{
  "errors": [
    {
      "errorCode": "120001",
      "message": "This API key cannot be used."
    }
  ]
}