> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# HTTP コネクタ

> YiDA コネクタファクトリーを利用してカスタム HTTP コネクタを構築し、DingTalk アプリ・社内システム・サードパーティシステムと連携する方法を解説します。コネクタの作成手順、認証方法の設定、アクションの構成、テストの実施までを詳しく紹介します。

| **機能**    | **Freeプラン** | **ベーシック版** | **プロフェッショナル版** | **専用版** |
| --------- | ----------- | ---------- | -------------- | ------- |
| HTTP コネクタ | 1           | 1          | 無制限            | 無制限     |

DingTalk 公式のコネクタでは要件を満たせず、DingTalk アプリ・社内システム・サードパーティシステムとの連携を急ぐ場合は、YiDA コネクタファクトリーを利用してカスタムデータコネクタを構築できます。

## ステップ 1：コネクタを作成する

<Steps>
  <Step title="手順 1">
    管理者として [YiDA ワークベンチ](https://www.yidaapps.com/workPlatform) にログインします。
  </Step>

  <Step title="手順 2">
    右上の **プラットフォーム管理** ボタンをクリックし、プラットフォーム管理ページを開きます。
  </Step>

  <Step title="手順 3">
    左側のメニューで **コネクタファクトリー** をクリックし、**コネクタを作成** をクリックしたうえで、HTTP コネクタを選択します。
  </Step>
</Steps>

<Steps>
  <Step title="以下の内容を参考にコネクタの基本情報を設定し、次へをクリックします" />

  <Step title="以下の内容を参考に認証方法を設定します" />
</Steps>

| **認証方法**                  | **説明**                                                                                                                                                                                                                                                                                                           |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 認証なし                      | 認証なしとは、API 呼び出しに認証情報が不要であることを意味します。通常、公開 API で使用されます。                                                                                                                                                                                                                                                            |
| Basic 認証                  | 標準的な HTTP 権限付与です。リクエストヘッダーに認証情報を含め、サーバーがこれを利用してユーザーエージェントの身元を検証します。Base64 でエンコードしたアカウントとパスワードをヘッダーに追加します。例：`Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l`。<br />エンコード形式：`account:password`。<br />設定が必要なのはアカウントとパスワードのフィールドラベルのみです。これらは認証情報の登録時に、ユーザーへの入力プロンプトとして表示されます。<br />• **ユーザー名ラベル**<br />• **パスワードラベル** |
| API Key                   | **API Key** 認証方式です。API Key は長期間有効です（安全に保管してください）。リクエスト元はターゲットシステムでシークレットキーを生成し、開発者はこの認証情報を利用して、この認証方式に対応する公開 API を呼び出せます。<br />• **パラメータラベル**：認証情報の設定時にプロンプトとして表示されます。<br />• **パラメータ名**：システムで必要な apiKey の名前です。<br />• **パラメータの位置**：認証情報をクエリパラメータとして付加するか、ヘッダーに含めるかを、ターゲットシステムの要件に応じて選択します。                      |
| Alibaba Cloud API Gateway | コネクタ作成後、認証情報テンプレートを追加します。テンプレートに App Code を入力すると、対応する Alibaba Cloud API を呼び出せます。<br />詳細については、[AppCode 認証による API 呼び出し](https://help.aliyun.com/document_detail/115437.html) を参照してください。                                                                                                                           |
| DingTalk オープンプラットフォーム認証   | コネクタ作成後、認証情報テンプレートを追加します。テンプレートに `App Key` と `App Secret` を入力すると、DingTalk オープンプラットフォーム API（YiDA の一部 API を含む）を呼び出せます。<br />認証情報テンプレートを追加すると、YiDA は認証を経て自動的に `access_token` を生成し、各リクエストの `Header` パラメータ `x-acs-dingtalk-access-token` に追加します。再生成は不要です。<br />詳細については、DingTalk アプリ開発プロセス を参照してください。                  |
| DingTalk ゼロトラストゲートウェイ     | DingTalk ゼロトラストゲートウェイの使用方法の詳細については、DingTalk オープンプラットフォーム - ゼロトラストゲートウェイ認証 を参照してください。                                                                                                                                                                                                                             |

## ステップ 2：アクションを作成する

アクションページで **アクションを作成** をクリックし、以下の情報に基づいて設定します。

| **名前**    | **説明**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 基本情報      | 現在のアクションの基本情報を設定します。<br />• **固定値の識別子**：異なるアクションを区別するために使用します。<br />• アクション名：アクションの名前です。<br />• アクションの説明：アクションの説明です。<br />                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| API リクエスト | 現在のアクションがトリガーされた際に呼び出す API エンドポイントを設定します。<br />• **リクエスト URL**：API リクエストのリンクです。リクエストドメインはコネクタのドメインで自動的に入力されます。<br />• **HTTP メソッド**：GET、POST、DELETE、PUT、HEAD、OPTIONS、PATCH などのメソッドに対応します。<br />• **Query**：リクエストパラメータで、通常は URL のクエスチョンマーク `?` の後に付加します。プラス記号をクリックして追加します。<br />• **Body**：POST などのメソッドでは Body フィールドを含めることもできます。JSON による解析に対応します。<br />• **Headers**：ここで追加のリクエストヘッダーをカスタマイズできます。現時点では静的な設定のみに対応します。<br />• **Path**：URL 内の中括弧で囲まれた変数です。例：`{pathParam}`。この場合、`pathParam` が変数名として使用されます。<br />**注意**：リクエストパラメータでは、ログインユーザー ID と組織 ID のシステムフィールドに対応しています。 |
| API レスポンス | API 呼び出しが成功した後の想定レスポンスを設定します。JSON 解析に対応します。<br />**注意**：API が JSON オブジェクト以外を返す場合、統合と自動化で直接使用することはできません。スクリプトノードで独自に解析する必要があります。                                                                                                                                                                                                                                                                                                                                                                                                                                       |

## ステップ 3：認証を設定する

すべてのカスタムデータコネクタには、対応するリクエスト認証スキームが必要です。**認証なし** の場合も同様です。

1. アカウントを作成する

設定済みのコネクタで、テストをクリックして認証アカウントを選択します。この手順で新しい認証アカウントを追加することもできます。

2. アカウント表示名、AppKey、AppSecret などの情報を入力し、**確認** をクリックします。

## ステップ 4：コネクタをテストする

<Steps>
  <Step title="コネクタ詳細ページで、右上のテストボタンをクリックします" />

  <Step title="使用する認証を選択し、テストパラメータを設定します" />

  <Step title="テストをクリックします。想定どおりの結果が表示されれば、設定は成功です" />
</Steps>