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

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

skills リソースに GET リクエストを送信します。 次のコマンドを実行します： その結果、アプリケーション インスタンスに追加されたすべての Skill の情報が返されます。

​
ステップ 2. トランザクションを作成して開始する

トランザクションを作成して開始するには、POST リクエストを transactions/launch リソースに送信します。 URL では、クエリパラメーター skillId（前の API 呼び出しで返された値）を指定します。リクエストボディには、処理対象のファイルと任意のメタデータを送信します。また、任意で registrationParameters および skillParameters をリクエストボディに渡すこともできます。 以下はリクエストボディの例です。 
{
  "files": [
    {
    }
  ]
}
次のコマンドを実行してください。 これにより、作成されたトランザクションの id を含むレスポンスが返されます。

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

トランザクションのステータスを監視するには、transactions リソースに対して GET リクエストを送信します。 次のコマンドを実行します： その結果、トランザクションのステータスを含むレスポンスが返されます。トランザクション処理のステータスは次のいずれかです。
  • New。トランザクションは作成されましたが、まだ処理キューに入っていません。
  • Queued。トランザクションは処理キューに入っています。
  • InProgress。トランザクションは処理中です。
  • Processed。トランザクションは正常に処理されました。
  • ProcessedWithWarnings。トランザクションは処理されましたが、警告が発生しました。
  • NotProcessed。トランザクションはエラーにより処理されませんでした。
  • Deleted。トランザクションはユーザーによって、または保持ポリシーにより自動的に削除されました。
トランザクションのステータスが Processed または ProcessedWithWarnings の場合は、手順 4 に進みます。

​
ステップ 4. ソースファイルと結果ファイルのダウンロード

ソースファイルと結果ファイルをダウンロードするには、前のリクエストで取得したファイル ID を指定して、transactions/files/download リソースに GET リクエストを送信します: 次のコマンドを実行します：