> ## 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连接器

> 本文介绍了如何使用宜搭连接器工厂创建自定义HTTP连接器的步骤，包括新建连接器、配置身份验证类型以及创建执行动作。适用于需要通过自定义方式打通钉钉应用与其他系统之间的用户。

| **功能**  | **免费版** | **轻享版** | **专业版** | 专属版  |
| ------- | ------- | ------- | ------- | ---- |
| HTTP连接器 | 1 个     | 1个      | 不限数量    | 不限数量 |

如果当钉钉官方连接器无法满足你的需求，但又急需打通钉钉应用、自建系统或者第三方应用系统时，你可以通过宜搭连接器工厂进行自定义连接器。

## 步骤一：新建连接器

<Steps>
  <Step title="步骤 1">
    使用管理员身份登录[宜搭工作台](https://www.yidaapps.com/workPlatform)。
  </Step>

  <Step title="步骤 2">
    单击右上角**平台管理**<img className="inline-icon" src="https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1703646834204-6f254b32-698e-4f8d-ac24-49bc23b25e45.png" width="20" alt="" />按钮，进入平台管理页面。
  </Step>

  <Step title="步骤 3">
    单击左侧菜单栏**连接器工厂**，然后单击**新建连接器**，选择HTTP连接器。
  </Step>
</Steps>

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1703648508494-bad3a8e1-03e2-481d-ba5d-ce866cf8e249.png)
</Frame>

<Steps>
  <Step title="参考以下信息配置连接器的基本信息，配置完成后单击 下一步">
    <Frame>
      ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1703655701005-3c99d0e4-7d70-4ee9-bca4-0eb07a206f41.png)
    </Frame>
  </Step>

  <Step title="参考以下内容，配置 身份验证类型">
    <Frame>
      ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1703663002197-035664f4-2f14-40d8-a16c-6833d6350cc9.png)
    </Frame>
  </Step>
</Steps>

| **身份验证类型** | **说明**                                                                                                                                                                                                                                                                                                      |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 无身份验证      | 无身份验证就是不需要任何验证信息，直接调用的接口，通常用于访问一些公开的接口。                                                                                                                                                                                                                                                                     |
| 基本身份验证     | 基本身份验证是指基于的 HTTP请求中 Authorization 请求头的验证。请求消息头含有服务端用于验证用户代理身份的凭证。<br />• **格式为**：`Authorization: Basic <密文>`。<br />例如：你可以在 Header 中加入`Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l` 的Base64 编码后账号密码信息。<br />你只需要配置账号密码的提示标签，用于提示使用者在注册鉴权信息知道填写什么内容。<br />例如：<br />• **username 标签**<br />• **password 标签** |
| API 密钥     | 即 **APIKey** 鉴权方式，该APIKey长期有效（请开发者妥善保管），访问者在待访问的系统中创建生成秘钥，开发者可直接通过此凭证调用支持此类鉴权的公开 API。<br />• **参数标签**：用于配置鉴权信息时提示。<br />• **参数名称**：系统需要的 apiKey 名称。<br />• **参数位置**：可以选择把鉴权信息附加在查询参数或者 header 里，根据请求的系统需要选择。                                                                                                |
| 阿里云 API 网关 | 即连接器创建完成之后添加鉴权模板时，模板填写 App Code 后可调用对应的阿里云API。<br />更多内容请参考，[使用认证 App Code 方式调用API](https://help.aliyun.com/document_detail/115437.html)。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1653272675853-1924c0b8-8f7a-4071-953f-747fc32b8da9.png)                                     |
| 钉钉开放平台验证   | 创建完连接器后添加鉴权模板，模板填写 `App Key` 、`App Secret` 后可调用钉钉开放平台API（含宜搭部分API）。<br />添加鉴权模板后宜搭会通过鉴权自动生成鉴权参数 `access_token` ，在请求时添加到 `Header` 参数 `x-acs-dingtalk-access-token` 中，无需再次生成。<br />更多内容，请参考[钉钉应用开发流程](https://open.dingtalk.com/document/orgapp/overview-of-development-process)。                             |
| 钉钉零信任网关    | 如何使用钉钉零信任网关，可参考[钉钉开放平台-零信任网关鉴权](https://open.dingtalk.com/document/connector/untitled-document-4)。                                                                                                                                                                                                          |

## 步骤二：创建执行动作

在执行动作页面，单击**新增执行动作**，然后根据以下信息进行配置。

| **名称** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                           |
| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 基本信息   | 配置当前执行动作的基本信息。<br />• **唯一标识**：用于识别不同的操作。<br />• 动作名称：执行动作的名称。<br />• 动作描述：执行动作的描述信息。                                                                                                                                                                                                                                                                                                                            |
| 接口请求   | 配置当前执行动作触发时，对哪个接口发起请求。<br />• **请求地址**：接口请求链接，请求域名会自动填充为连接器的域名。<br />• **请求方式**：支持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。 |
| 接口返回   | 用于配置接口调用成功后，预期的返回结果，支持使用JSON进行解析。<br />**说明**：如果接口返回非JSON对象，则不支持在集成自动化中直接使用，需在脚本节点自行解析。                                                                                                                                                                                                                                                                                                                          |

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1703665595707-59ddd128-e037-492a-ad61-6eab670fb676.png)
</Frame>

## 步骤三：鉴权配置

所有的自定义连接器都需要建立对应的请求鉴权方案，即使是「**无身份验证**」也需要创建。

1. 新建账号

已设置好的连接器点击测试则会出现选择鉴权账号，此时也可以新增鉴权账号。

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1653271348654-3c1908f7-8f6e-4c34-ae11-33aa5b6e8644.png)
</Frame>

2. 输入 账号显示名称 、 App Key 、 App Secret 等信息，然后 单击 确认 。

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1653271469186-06ad8b35-268a-4c10-a9da-f38bf1a4ecad.png)
</Frame>

## 步骤四：测试连接器

<Steps>
  <Step title="在连接器详情页，单击右上角 测试 按钮">
    <Frame>
      ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1703665664686-bb99ad10-c5b9-4f6a-b3b1-78d0cd44b3e1.png)
    </Frame>
  </Step>

  <Step title="选择使用的鉴权，配置测试的参数">
    <Frame>
      ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1653271984053-6a9c9250-892c-44b0-89b9-ecca29c3b996.png)
    </Frame>
  </Step>

  <Step title="单击 测试 ，出现预期结果即为配置成功">
    <Frame>
      ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1653272026007-900807cf-c724-4d91-a02d-ec5f45680557.png)
    </Frame>
  </Step>
</Steps>
