> ## Documentation Index
> Fetch the complete documentation index at: https://docs-eos.fpt.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Space でのカスタム API コネクタ

> Swagger/OpenAPI ドキュメントのインポートまたは手動定義で、Workspace のコネクタページから REST API コネクタを作成・表示・編集・削除します。

> [!NOTE]
>
> **REST API コネクタ**は、REST API の各操作（operation）を Digital Worker が呼び出せるツールに変換します。Connector の作成と管理は Workspace の**コネクタ**ページで行い、Digital Worker の詳細画面で各 Digital Worker に追加して、操作ごとに権限を設定します。

## 機能の入口

| 入口 | 操作手順 | 用途 |
| - | - | - |
| コネクタページ | 左サイドバー → **コネクタ** → **Custom Connectors** タブ → **コネクタを追加** → **REST API** | Connector の作成・表示・編集・削除 |
| 空の状態の画面 | Connector がまだない **Custom Connectors** タブ → 中央の**コネクタを追加**ボタン | 最初の Connector の作成 |
| Digital Worker の詳細画面 | **マイDigital Worker** → Digital Worker を開く → **ビルド** → **設定**パネル → **コネクタ**セクション → **+** | Digital Worker への追加、権限設定、Digital Worker からの削除 |
| Digital Worker のコネクタ選択画面 | コネクタ選択ダイアログ → **コネクタを作成** → **REST API** | Digital Worker 画面を離れずに Connector を作成 |

## 始める前に

* **API ドキュメント**: OpenAPI 3.x または Swagger 2.0 のファイル（JSON/YAML、最大 2 MB）。ドキュメントがない場合は、手動で定義するためにベース URL とエンドポイントの一覧を用意します。
* **公開されたベース URL**: ローカルマシンやプライベート IP 帯（例: `localhost`、`169.254.169.254`）を指すアドレスは登録できません。できるだけ `https` を使ってください。
* **認証情報**: API キー / トークン、または API の OAuth 2.1 情報。
* **上限**: 1 つの Connector に登録できる操作は最大 200 件です。それより多い場合は、先頭の 200 件だけがインポートされます。

## Connector を作成する

### 方法 1: Swagger/OpenAPI ドキュメントをインポートする

**1. Custom Connectors タブを開く**

左サイドバーの**コネクタ**をクリックし、**Custom Connectors** タブを選びます。

![Connector がまだない Custom Connectors タブ](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_empty.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=492e5b684e135dd73c61b717fc6006b6)

**2. コネクタを追加 → REST API を選ぶ**

メニューには **REST API**（Swagger/OpenAPI のインポートまたは手動定義）と **MCP サーバー**（URL で MCP サーバーを接続）があります。**REST API** を選びます。

![REST API と MCP サーバーが表示されたコネクタを追加メニュー](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_add_menu.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=0cdb220fd79dd3b2062cfe28702835ac)

**3. ステップ 1 ソース: ドキュメントを読み込む**

**Swagger/OpenAPI をインポート**タブで、ファイルを枠内にドロップするか**ファイルを選択**をクリックします。**またはドキュメントの内容を貼り付け**の欄に内容を貼り付けることもできます。**次へ**をクリックします。

![OpenAPI ドキュメントを貼り付けたソースステップ](https://mintcdn.com/fpt-15dbd015/38Dm9D-hll-psE1A/images/eos/ja_custom_api_source_import.jpg?fit=max\&auto=format\&n=38Dm9D-hll-psE1A\&q=85\&s=d23da6746d71e2123b88d78cc56a8bb7)

**4. ステップ 2 接続: 接続情報を確認する**

名前、**ベース URL**、**認証**の種類はドキュメントから自動入力され、**ドキュメントから取得**のラベルが付きます。内容を確認し、API にキーが必要なら**値**を入力して**次へ**をクリックします。各項目の説明は下の「接続ステップの項目」を参照してください。

![ドキュメントから取得したベース URL と認証が表示された接続ステップ](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_connection.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=c35bd6e44d2c031d0151f1121ae8cca4)

**5. ステップ 3 操作: Digital Worker に許可する操作を選ぶ**

各操作には、メソッド、パス、リスクのラベル、Digital Worker に表示されるツール名（例: `demo-orders-api__list_orders`）、説明が表示されます。不要な操作のチェックを外す、メソッドで絞り込む、操作を展開して説明やパラメータを編集する、といった調整ができます。**コネクタを作成**をクリックします。

![5 件の操作を選択した操作ステップ](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_operations.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=3a191e2eaf958ecfb5a411843320ce4a)

**6. 結果を確認する**

「**N 件の操作でコネクタを作成しました。**」と表示され、**接続済み**のステータスで Connector のカードが追加されます。

![接続済みと表示された新しい Connector のカード](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_card.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=59e94bf6ecd823d085edd41cda35b802)

> [!TIP]
>
> Digital Worker は操作の説明を読んで、いつ API を呼び出すかを判断します。元のドキュメントに `summary` がある場合でも、操作の内容と使う場面がわかる説明に書き直すことをおすすめします。

### 方法 2: 手動で定義する

API に OpenAPI ドキュメントがない場合や、Digital Worker に公開するエンドポイントを一部に絞りたい場合に使います。

**1. 手動で定義タブを選ぶ**

**API コネクタを作成**ダイアログで**手動で定義**タブを選び、**次へ**をクリックします。

![ソースステップの手動で定義タブ](https://mintcdn.com/fpt-15dbd015/38Dm9D-hll-psE1A/images/eos/ja_custom_api_source_manual.jpg?fit=max\&auto=format\&n=38Dm9D-hll-psE1A\&q=85\&s=bb981ae431ddafeb19de43875b9d5222)

**2. 接続情報を入力する**

方法 1 と同様に、**名前**と**ベース URL** を入力し、**認証**の種類を選びます。

**3. 操作を 1 件ずつ定義する**

**メソッド**、**パス**、**名前**、**リスク**、**説明**、パラメータ、**返される内容**を入力します。操作を追加して定義を続け、最後に**コネクタを作成**をクリックします。

![注文詳細を取得する操作の定義フォーム](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_manual_ops.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=79234f646fbb6b4b26888ebeaf96cb8a)

> [!TIP]
>
> **パス**にパスパラメータを `{order_id}` の形式で書くと、Console が **Path** のパラメータを自動で追加します。

### 接続ステップの項目

| 項目 | 必須 | 説明 | 例 |
| - | - | - | - |
| **名前** | はい | Connector の表示名です。他の Connector と重複できません。ツール名の接頭辞にもなります | `Demo Orders API` |
| **ベース URL** | はい | API のルートアドレスです。各操作のパスはこの URL の後ろに連結されます | `https://api.example.com/v1` |
| **認証** | はい | **認証なし**、**API キー / トークン**、**OAuth 2.1 (Auto)**、**OAuth 2.1 (Manual)** のいずれか | API キー / トークン |
| **送信先** | API キー選択時 | キーを**ヘッダー**と**クエリ**のどちらで送るか | ヘッダー |
| **ヘッダー名** | API キー選択時 | キーを入れるヘッダー名またはクエリパラメータ名 | `X-API-Key`、`Authorization` |
| **値** | API キー選択時 | キーまたはトークン。暗号化して保存され、再表示されません | `sk-...` |
| **保存時に接続をテスト** | いいえ | パラメーター不要の GET 操作を呼び出して、キーが有効か確認します | オン |
| **詳細設定 → 説明（任意）** | いいえ | API の短い説明。Connector のカードに表示されます | 注文管理 API |
| **詳細設定 → テストに使う操作** | いいえ | 接続テストに使う GET 操作。既定では自動で選ばれます | `list_orders` |

OAuth 2.1 の場合:

| 種類 | 入力する内容 | 補足 |
| - | - | - |
| **OAuth 2.1 (Auto)** | 追加の入力は不要 | Console がベース URL から OAuth エンドポイントを検出し（RFC 9728、RFC 8414）、クライアントを自動で登録します（RFC 7591） |
| **OAuth 2.1 (Manual)** | **Authorize URL**、**Token URL**、**Client ID**。任意: **Client secret**、**スコープ**（スペースまたはカンマ区切り） | OAuth メタデータを公開していない、またはクライアント登録を許可しない API 向けです |

どちらの OAuth でも、保存後に認可用のウィンドウが開きます。

### 操作ステップの項目

| 項目 | 必須 | 説明 | 例 |
| - | - | - | - |
| **メソッド** | はい | `GET`、`POST`、`PUT`、`PATCH`、`DELETE` | `GET` |
| **パス** | はい | ベース URL の後ろに連結されるパス。パスパラメータは `{id}` の形式で書きます | `/orders/{order_id}` |
| **名前** | はい | ツール名です。Digital Worker には `コネクタ名__名前` の形式で表示されます | `get_order` |
| **リスク** | はい | **読み取りのみ**、**データを書き込む**、**データを削除する可能性あり**のいずれか。Digital Worker に追加したときの既定の権限が決まります | 読み取りのみ |
| **説明** | 推奨 | Digital Worker はこの説明を読んで、操作を呼び出すタイミングを判断します | 注文 ID を指定して注文の詳細を取得します。 |
| **パラメータ** | いいえ | 名前、位置（**Path**、**Query**、**Header**、**ボディのフィールド（JSON）**、**ボディ全体（JSON）**、**フォームのフィールド**）、型、説明、**必須**のチェックで構成します。**表**または **JSON** で編集できます | `order_id`、Path、string |
| **返される内容** | いいえ | API が返すデータの説明。最大 1000 文字です | 注文ステータス、合計金額、顧客名。 |

ドキュメントをインポートすると、リスクはメソッドから推定されます。`GET` は**読み取りのみ**、`POST`/`PUT`/`PATCH` は**データを書き込む**、`DELETE` は**データを削除する可能性あり**です。操作を展開すれば変更できます。

## Connector の一覧を確認する

**Custom Connectors** タブには Connector の件数と、Connector ごとのカードが表示されます。

* Connector の**名前**と**説明**。
* **ステータス**（例: **接続済み**）。
* **操作の件数**と作成元（ドキュメントからインポートした場合は **OpenAPI**）。
* 削除用の**ごみ箱**アイコンと、編集用の**管理**ボタン。

Connector が増えたら、**カスタムコネクタを検索...** の欄で名前を絞り込めます。

## Connector を編集する

カードの**管理**をクリックすると、**API コネクタを編集**ダイアログが開きます。**ソース**、**接続**、**操作**の 3 つのタブがあります。編集が終わったら**変更を保存**をクリックします。

### 接続情報を変更する

**接続**タブでは、名前、ベース URL、認証の種類を変更できます。保存済みのキーは「**•••• 保存済み**」と表示されます。新しいキーを入力するには**キーを変更**をクリックします。

![API コネクタを編集ダイアログの接続タブ](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_edit_connection.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=3ca9c05b82582287d02394b7f4499594)

ベース URL または認証の種類を変更すると、既存の接続はすべて切断され再接続が必要になる旨の警告が表示されます。

![アドレスや認証方式を変更したときの警告](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_auth_warning.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=c83567253e9c176ac2d6be1b53932c31)

### API の変更に合わせてドキュメントを再インポートする

**1. 新しいバージョンのドキュメントを読み込む**

**ソース**タブで、新しいファイルをドロップするか、新しい内容を貼り付けます。

![バージョン 1.1.0 のドキュメントを貼り付けたソースタブ](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_reimport.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=54c837f9a4a334d98727b000b93e9be0)

**2. 操作タブを確認する**

**操作**タブを開いてインポート後の一覧を確認し、使う操作を選び直します。

![再インポート後に返金の操作が追加された操作タブ](https://mintcdn.com/fpt-15dbd015/38Dm9D-hll-psE1A/images/eos/ja_custom_api_reimport_operations.jpg?fit=max\&auto=format\&n=38Dm9D-hll-psE1A\&q=85\&s=b83eef96983a1b925bafdc3e0ff51b3f)

**3. 変更を保存する**

**変更を保存**をクリックします。Connector のカードの操作件数が更新されます。

> [!WARNING]
>
> 再インポートすると、**操作の一覧全体**が新しいドキュメントの内容に置き換わります。新しいドキュメントで削除または名前変更された操作は、この Connector を使っている Digital Worker から使えなくなります。保存後は該当する Digital Worker を開いて各操作の権限を確認し、もう一度テスト実行してください。

未保存の変更があるまま**キャンセル**をクリックすると、「**変更を破棄しますか？**」と確認されます。**破棄する**で終了し、**編集を続ける**で編集に戻ります。

## Connector を削除する

**1. Connector のカードのごみ箱アイコンをクリックする**

確認ダイアログが表示されます。

![Connector の削除確認ダイアログ](https://mintcdn.com/fpt-15dbd015/gDW0AWl75k3m2kQW/images/eos/ja_custom_api_delete.jpg?fit=max\&auto=format\&n=gDW0AWl75k3m2kQW\&q=85\&s=73edbb07ae4cd325a2cc7f6b669b26dc)

**2. コネクタを削除をクリックする**

「**コネクタを削除しました。**」と表示され、Connector を使っていたすべての Digital Worker から自動的に外されます。

> [!WARNING]
>
> Connector の削除は**元に戻せません**。この Connector の操作を使っている Digital Worker は、すぐにアクセスできなくなります。ダイアログには影響を受ける Digital Worker が表示されないため、削除前に確認してください。

> [!NOTE]
>
> Connector には一時停止の状態はありません。特定の Digital Worker で一時的に使えなくしたい場合は、その Digital Worker から Connector を外すか、操作を**ブロック**に設定してください。

作成した Connector は、[Digital Worker でカスタム API を使う](https://docs-eos.fpt.ai/eos/ja/agent-custom-api-connectors.md) の手順で Digital Worker に追加します。

## よくあるエラー

| 現象 | 原因 | 対処 |
| - | - | - |
| 同じ名前のコネクタが既にあるというメッセージ | 名前が既存の Connector と重複している | 接続ステップで名前を変更する |
| コネクタを作成したときに、ベース URL は公開アドレスにする必要があるというメッセージ | ベース URL がローカルマシンやプライベート IP を指している | API の公開アドレスを使う |
| 200 件の操作しかインポートされない | ドキュメントに 200 件を超える操作がある | 業務ごとにドキュメントを分け、複数の Connector にする |
| ドキュメントを読み込めない | JSON/YAML の構文エラー、または OpenAPI/Swagger 形式ではない | OpenAPI のバリデーターで確認してから再インポートする |
| `api-n-h-ng-demo__...` のような不自然なツール名になる | Connector 名にアクセント付き文字が含まれ、`-` に置き換えられた | `Orders API` のように ASCII 文字だけの名前にする |

## 関連ページ

> **[Digital Worker でカスタム API を使う](https://docs-eos.fpt.ai/eos/ja/agent-custom-api-connectors.md)**
>
> Connector を Digital Worker に追加し、権限を設定してテストします。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.