メインコンテンツへスキップ
単一のAPI呼び出し（トランザクションの作成、ファイルのアップロード、トランザクションの開始）でドキュメントを処理する一般的なシナリオは、次の手順で構成されます。
  1. 利用可能なすべてのSkillの一覧を取得する
  2. トランザクションを作成して開始する
  3. トランザクションのステータスを監視する
  4. ソースファイルと結果ファイルをダウンロードする
各リクエストには認証情報を含める必要があります。詳細はAuthenticationを参照してください。 このシナリオは、30 MB未満のファイルが1つだけで、ファイル画像の編集が不要な場合に使用します。

​
利用可能なすべての Skill の一覧を取得する

skills リソースに GET リクエストを送信します。 
GET https://your-server/api/publicapi/v1/skills
次のコマンドを実行します： Windows の場合： 
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
Linux の場合: 
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
その結果、アプリケーション インスタンスに追加されたすべての Skill の情報が返されます。

​
トランザクションの作成と開始

そのためには、transactions/launch リソースに POST リクエストを送信します。 
POST https://your-server/api/publicapi/v1/transactions/launch
リクエスト本文には、直前の API 呼び出しで返された skillId Parameter を指定し、処理対象のファイルを送信します。リクエスト本文の例は次のとおりです。 
{
  "settings": {
    "skillId": "00000000-0000-0000-0000-000000000001"
  },
  "files": [
    {
      "file": "image content"
    }
  ]
}
次のコマンドを実行します： Windows の場合: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/launch" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"settings\": {
     \"skillId\": \"00000000-0000-0000-0000-000000000001\"
   },
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Linux の場合: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/launch' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "settings": {
     "skillId": "00000000-0000-0000-0000-000000000001"
   },
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
その結果、作成されたトランザクションのidを含む応答が返されます。

​
トランザクションのステータスを監視する

そのためには、transactions リソースに対して GET リクエストを送信します。 
GET https://your-server/api/publicapi/v1/transactions/transaction-id
次のコマンドを実行します： Windows の場合: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
Linux の場合: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
その結果、トランザクションのステータスを含むレスポンスが返されます。トランザクション処理のステータスは次のいずれかです。
  • New。トランザクションは作成されましたが、まだ処理キューに入っていません。
  • Queued。トランザクションは処理キューに入っています。
  • InProgress。トランザクションは処理中です。
  • Processed。トランザクションは正常に処理されました。
  • ProcessedWithWarnings。トランザクションは処理されましたが、警告が発生しました。
  • NotProcessed。トランザクションはエラーにより処理されませんでした。
  • Deleted。トランザクションはユーザーによって、または保持ポリシーにより自動的に削除されました。
トランザクションのステータスが Processed または ProcessedWithWarnings の場合は、手順 4 に進みます。

​
ソースファイルと結果ファイルのダウンロード

ソースファイルをダウンロードするには、前のリクエストで取得したファイル ID を指定して、transactions/files/download リソースに GET リクエストを送信します。 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
次のコマンドを実行します： Windows の場合: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
Linux の場合: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'