# Local API リファレンス

ブラウザ RPA Local API は、MoreLogin デスクトップクライアント V2.73.0 以降が `http://127.0.0.1:<port>/api/rpa/browser/v1` で提供します。ポートには、クライアントの設定に表示される Local API のポートを使用してください。既定値は `40000` です。

認証は、ほかの Local API と同じ方法で行います。[認証](/ja/api-reference/getting-started/authentication)を参照してください。JSON の本文は `Content-Type: application/json` を付けて送信します。成功レスポンスは `{data,meta}`、エラーレスポンスは `{error,meta}` です。認証に失敗した場合は、Local API 標準の 401 形式で返されます。エラーは、メッセージのテキストではなく、HTTP ステータス、`error.code`、`details`、issue のパスに基づいて処理してください。ルールの詳細は [API の規約](/ja/browser-rpa/api/common)で説明しています。

## エンドポイント一覧

### 機能とノード

| 操作 | メソッドと相対パス |
|  --- | --- |
| [機能を取得](/ja/browser-rpa/api/get-capabilities) | `GET /capabilities` |
| [ノードタイプ一覧](/ja/browser-rpa/api/list-node-types) | `GET /node-types` |
| [ノード契約を取得](/ja/browser-rpa/api/get-node-type) | `GET /node-types/{nodeType}` |


### ワークフローの検証

| 操作 | メソッドと相対パス |
|  --- | --- |
| [ワークフローを検証](/ja/browser-rpa/api/validate-workflow) | `POST /validations` |


### テンプレートとノードの編集

| 操作 | メソッドと相対パス |
|  --- | --- |
| [テンプレート一覧](/ja/browser-rpa/api/list-templates) | `GET /templates` |
| [テンプレートを作成](/ja/browser-rpa/api/create-template) | `POST /templates` |
| [テンプレートを取得](/ja/browser-rpa/api/get-template) | `GET /templates/{templateId}` |
| [テンプレートを置き換え](/ja/browser-rpa/api/replace-template) | `PUT /templates/{templateId}` |
| [テンプレートを削除](/ja/browser-rpa/api/delete-template) | `DELETE /templates/{templateId}` |
| [テンプレートをコピー](/ja/browser-rpa/api/copy-template) | `POST /templates/{templateId}/copies` |
| [テンプレートノード一覧](/ja/browser-rpa/api/list-template-nodes) | `GET /templates/{templateId}/nodes` |
| [テンプレートノードを編集](/ja/browser-rpa/api/edit-template-nodes) | `POST /templates/{templateId}/node-edits` |


### 実行と結果

| 操作 | メソッドと相対パス |
|  --- | --- |
| [実行を開始](/ja/browser-rpa/api/start-run) | `POST /runs` |
| [実行一覧](/ja/browser-rpa/api/list-runs) | `GET /runs` |
| [実行の詳細を取得](/ja/browser-rpa/api/get-run) | `GET /runs/{runId}` |
| [実行をキャンセル](/ja/browser-rpa/api/cancel-run) | `POST /runs/{runId}/cancel` |
| [ノード実行一覧](/ja/browser-rpa/api/list-run-nodes) | `GET /runs/{runId}/nodes` |
| [実行成果物一覧](/ja/browser-rpa/api/list-run-artifacts) | `GET /runs/{runId}/artifacts` |


### リクエストのリカバリー

| 操作 | メソッドと相対パス |
|  --- | --- |
| [リクエスト受領記録を取得](/ja/browser-rpa/api/get-request-receipt) | `GET /requests/{key}` |


### 共通リファレンス

- [API の規約](/ja/browser-rpa/api/common)
- [データモデル](/ja/browser-rpa/api/data-types)
- [ワークフロー、変数、構造ノード](/ja/browser-rpa/api/workflow)
- [エラーコード](/ja/browser-rpa/api/error-codes)
- [エラー詳細とリカバリーマトリクス](/ja/browser-rpa/api/recovery)
- [実行の監視とリクエストのリカバリー](/ja/browser-rpa/api/observation)


## 書き込みリクエストに必要なヘッダー

| 操作 | `Idempotency-Key` | `X-RPA-Catalog-Revision` | `If-Match` |
|  --- | --- | --- | --- |
| [テンプレートを作成](/ja/browser-rpa/api/create-template) | 推奨 | 必須 | — |
| [テンプレートを置き換え](/ja/browser-rpa/api/replace-template) | 推奨 | 必須 | 必須 |
| [テンプレートを削除](/ja/browser-rpa/api/delete-template) | 推奨 | 不要 | 必須 |
| [テンプレートをコピー](/ja/browser-rpa/api/copy-template) | 推奨 | 必須 | 必須（コピー元テンプレートの ETag） |
| [テンプレートノードを編集](/ja/browser-rpa/api/edit-template-nodes) | 推奨 | 必須 | 必須 |
| [実行を開始](/ja/browser-rpa/api/start-run) | 推奨 | 必須 | — |
| [実行をキャンセル](/ja/browser-rpa/api/cancel-run) | 推奨 | 不要 | — |


`Idempotency-Key` は省略できますが、省略するとタイムアウト後の再試行で書き込みが繰り返される可能性があります。新しい書き込みの意図ごとに新しい UUID を生成し、結果が判明するまで、メソッド、パス、本文、`If-Match` と一緒に保持してください。`If-Match` には、[テンプレートを取得](/ja/browser-rpa/api/get-template)が返す `ETag` をそのまま指定します。`X-RPA-Catalog-Revision` には、[機能を取得](/ja/browser-rpa/api/get-capabilities)が返す `data.catalogRevision` を指定します。[ワークフローを検証](/ja/browser-rpa/api/validate-workflow)は読み取り専用の操作です。これらのヘッダーはいずれも不要で、リクエスト受領記録も残りません。

## ローカルの機械可読な契約

HTTP の契約は、ローカルのベース URL の `/openapi.json` で読み取れます。ワークフローのスキーマの URL は、`GET /capabilities` が返す `data.docs.schema` にあります。

## 既存のテンプレートを編集する

最新のテンプレートと、編集するノードの契約を読み取ります。部分的な変更では、提案するノード編集をツリー全体に適用し、`purpose:"save"`、`source.kind:"inline"`、`source.base:{templateId,version}` を指定して検証します。候補が検証に合格したら、`node-edits` で操作を送信します。1 回のバッチでは、新しいバージョンが 1 つ保存されるか、何も変更されないかのどちらかです。ノードやブロックを置き換えるときは完全な内容を送信し、ノードを削除するときは参照を修正してください。テンプレート全体を置き換えるには PUT を使用します。子テンプレートの依存関係は現在の `{processId,revisionId}` として記録し、バージョン競合が発生した後は依存関係を読み直してください。

## リカバリー

| 状況 | 次の手順 |
|  --- | --- |
| 書き込みのタイムアウト、接続の切断、または結果が不明 | `GET /requests/{originalKey}` を照会します。`completed` の場合は元の結果を使用します。ただし、実行の登録が完了していても、実行ステータスの確認は必要です。`accepted` または `committed` の場合は、時間の上限を決めてポーリングします。`unknown`、通常の 404、または受領記録の期限切れの場合は、自動的な書き込みを停止してリソースを確認してください。 |
| `RPA_REQUEST_NOT_COMMITTED` が返され、`safeToRetrySameKey=true` の場合 | 元のキー、メソッド、パス、本文、および `If-Match`（ある場合）を使って、同じ意図のリクエストを再試行します。 |
| 412 バージョン競合 | まず受領記録を確認します。書き込みがコミットされていないことを確認したら、テンプレートを読み直してマージし、検証してから、新しいキーと現在の ETag で送信します。 |
| カタログが変更された | 受領記録を確認して書き込みがコミットされていないことを確かめてから、機能と契約を再取得します。本文と `If-Match` が変わらない場合は、カタログのヘッダーを更新し、元のキーをそのまま使用します。 |
| `valid=false` または確定的な入力エラー | 報告されたパスの問題を修正し、再度検証します。書き込みが失敗として記録されている場合は、何もコミットされていないことを確認してから新しいキーを使用してください。429 または 503 の場合は、`Retry-After` と受領記録のルールに従ってください。 |


保存したテンプレートを実行するには、[API でテンプレートを実行](/ja/browser-rpa/run-api-example)を参照してください。