API を使用したドキュメントの処理と結果の取得
IDP API を使用してドキュメントアクションを Mule アプリケーションや他のシステムと統合することで、データ抽出プロセスを自動化できます。IDP と統合するには、接続アプリケーションの作成、アクセストークンの取得、ドキュメントアクションを実行して結果を取得する IDP API のコールが必要です。
IDP API を使用して、パブリッシュ済みアクションを実行し、実行結果を取得します。また、プロセスの完了時に IDP がコールするコールバック URL も指定できます。
IDP API をコールしてドキュメントアクションを実行する代わりに、MuleSoft RPA から [Submit Document to MuleSoft IDP (ドキュメントを MuleSoft IDP に送信)] アクションステップと [Retrieve Results from MuleSoft IDP (MuleSoft IDP から結果を取得)] アクションステップを使用できます。ドキュメントアクションを MuleSoft RPA と統合する手順については、RPA を使用したドキュメントの処理と結果の取得を参照してください。
始める前に
次の Anypoint 権限があることを確認します。
- Execute Published Actions (パブリッシュ済みアクションの実行)
-
ユーザーがパブリッシュされたドキュメントアクションを実行し、実行結果を取得できるようにします。
接続アプリケーションの作成
IDP API と通信するには、次の詳細を使用して接続アプリケーションを作成します。
-
Type (種別):
App acts on its own behalf (client credentials) (アプリケーションが自身ために行動する (クライアントログイン情報)) -
Scopes (スコープ):
Execute Published Actions (パブリッシュ済みアクションの実行)
接続アプリケーションを作成したら、後で使用するために、その ID とシークレットをコピーしておきます。
詳細は、接続アプリケーションを参照してください。
アクセストークンの取得
接続アプリケーションを設定したら、次の curl コマンドを使用してトークンを取得します。
curl --location --request POST 'https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token' \ (1)
--header 'Content-Type: application/json' \
--data-raw '{
"grant_type": "client_credentials",
"client_id": "<connected-app-client-id>", (2)
"client_secret": "<connected-app-client-secret>" (3)
}'| 1 | EU 地域のユーザーは、eu1.anypoint.mulesoft.com ドメインを使用します。 |
| 2 | <connected-app-client-id> を接続アプリケーションのクライアント ID に置き換えます。 |
| 3 | <connected-app-client-secret> を接続アプリケーションのクライアントシークレットに置き換えます。 |
IDP API をコールするときにアクセストークンを使用します。
パブリッシュ済みドキュメントアクションの実行
ドキュメントアクションをパブリッシュし、接続アプリケーションを設定し、アクセストークンを取得したら、IDP API をコールしてドキュメントアクションを実行できます。
以下は、ドキュメントアクションを実行する API コールを作成する方法に関する案内を提供するサンプルコールです。
curl --location 'https://idp-rt.{region}.anypoint.mulesoft.com/api/v1/organizations/{orgId}/actions/{actionId}/versions/{actionVersion}/executions' \
--header 'Authorization: Bearer {token}' \
--form 'file=@"{pathToFile}"'パブリッシュ済みドキュメントアクションを照会すると、対応する項目のデータを抽出するために、各プロンプトで選択されたモデルが IDP で使用されます。
コールバック URL の定義
IDP をコールしてドキュメントアクションを実行するときのコールバック URL を定義できます。定義されている場合、SUCCEEDED、FAILED、または MANUAL_VALIDATION_REQUIRED の状態でドキュメントアクションの実行が完了すると、IDP によってコールバック URL がコールされます。
コールバック URL を指定するには、API コールに callback 項目を含め、コールバック URL で JSON 値を定義します。次の例は、前述の curl コマンドの例にコールバックを追加したものです。
curl --location 'https://idp-rt.{region}.anypoint.mulesoft.com/api/v1/organizations/{orgId}/actions/{actionId}/versions/{actionVersion}/executions' \
--header 'Authorization: Bearer {token}' \
--form 'file=@"{pathToFile}"' \
--form 'callback="{\"noAuthUrl\":\"{callbackURL}\"}"'Base64 でエンコードされたファイルのアップロード
IDP API をコールしてバージョン管理されたドキュメントアクションを実行するときに Base64 でエンコードされたファイルをアップロードできます。次に例を示します。
curl --location 'https://idp-rt.{region}.anypoint.mulesoft.com/api/v1/organizations/{orgId}/actions/{actionId}/versions/{actionVersion}/executions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
"file": {yourBase64string},
"fileName": {testFileName.pdf}
}'実行結果の取得
ドキュメントアクションでドキュメントが正常に処理された後、またはレビュー担当者がレビューのキューに追加されたドキュメントを確認して送信した後、結果を使用できます。
IDP API を使用してドキュメントアクションを実行する場合は、次に示すように /executions エンドポイントをコールし、executionId を指定して結果を取得します。
curl --location \
'https://idp-rt.{{region}}.anypoint.mulesoft.com/api/v1/organizations/{orgId}/actions/{actionId}/versions/{actionVersion}/executions/{executionId}/v2' \
--header 'Authorization: Bearer {token}'実行結果リファレンス
実行結果を照会すると、IDP API は次のいずれかの状況を返します。
-
ACKNOWLEDGED: ドキュメントアクションの実行要求が受信されました。 -
IN_PROGRESS: 実行が開始されました。 -
RESULTS_PENDING: 実行が完了し、IDP が結果を処理しています。 -
MANUAL_VALIDATION_REQUIRED: 実行は完了しましたが、結果の手動検証が必要です。 -
FAILED: 実行要求は正常に完了しませんでした。 -
PARTIAL_SUCCESS: 実行要求は完了しましたが、一部のサブタスクが失敗しました。 -
SUCCEEDED: 実行要求は正常に完了しました。