飞书智能伙伴Aily之自定义连接器

功能概述

飞书智能伙伴创建平台（Aily）目前已为企业提供了几十个主流的 Saas 系统连接器，帮助用户在工作流技能中高效集成外部系统。但同时，平台提供的连接器并不能覆盖所有外部系统，企业内也可能有内部系统（自研或外采SaaS）需要被集成。因此，我们提供了连接器开发工具，借助该工具，企业可以基于 HTTP 协议将各种内外部系统封装为连接器，并在 Workflow 中被使用，让集成能力进一步提高。

典型场景示例：

用户想要在工作流中调用一个查询电话号码归属地的 API ，但是平台没有提供该 API ，可以通过连接器开发工具进行开发，并在 Workflow 中使用该连接器

用户想要在工作流中集成企业自建的 OA 系统，可以先通过 HTTP 协议暴露 OA 系统的相关接口，再通过连接器开发工具开发连接器，并在 Workflow 中使用

连接器开发工具基本概念

连接器：在智能伙伴创建平台中的 Workflow 中，我们使用连接器访问外部系统的 OpenAPI，连接器内部封装了「接口调用」和「接口认证」两部分逻辑。

认证类型：描述了某个连接器和特定的系统如何建立连接，并完成连接器内的接口认证等逻辑。每个系统的认证类型取决于系统自身，常见的有Basic Auth、API Key、Bearer Token和OAuth等

凭证实例：用户基于某个认证类型，使用自己的 Key、Secret 等参数创建出的资源实例。在 Workflow 的连接器节点中，用户看到和创建的每一个凭证都是凭证实例。

操作：一个连接器操作对应系统中的一个 API ，包含一个API所需的必要信息，如URL、Header、Query等。操作也拥有认证类型，其支持的认证类型与连接器相同或为连接器的子集

注：

多个连接器可以共用一种认证类型，认证类型相同的连接器，凭证实例可以复用。例如，飞书自建应用这个认证类型在所有飞书连接器上都是通用的，飞书自建应用的凭证实例在所有飞书连接器上都可以选到。

一个连接器可以有多种认证类型，连接器下比如飞书连接器同时支持飞书应用授权和飞书用户授权两种类型。在操作维度，部分操作只支持飞书应用授权，部分操作只支持飞书用户授权，还有部分操作二者都支持

如何开发连接器

创建连接器

从Workflow和Smartflow中找到自定义连接器入口，进入连接器开发工具页面

250px|700px|reset

250px|700px|reset

如果你从未创建过连接器，则可以点击画面中间的新建按钮创建你的第一个连接器；如果你已经创建过连接器，可以点击右上角的【新建连接器】。

250px|700px|reset

新建连接器时需要提供如下信息：

认证类型：该连接器访问外部系统时需要使用的认证类型，平台内置了一些主流系统的认证类型，你也可以使用基础的认证方法如Basic Auth、API Key。

连接器图标：如果你想使用自定义的图标，则需要上传符合格式、尺寸、大小要求的图片。你也可以先使用默认图标，在创建后再替换连接器图标。

连接器名称：指连接器在 Workflow 和 Smartflow 中的默认展示名称，可以填中文。例如：我的自建连接器。

连接器说明：一段简要介绍用于说明连接器是做什么的。

Base URL：访问的外部系统的接口主域名，必须以HTTP或HTTPS开头

例如 Github API 的 Base URL 根据文档可知为 https://api.github.com，飞书开放平台 OpenAPI 的 Base URL 为 https://open.feishu.cn/open-apis，你需要将正确的值填写到 Base URL 中，用于所有连接器操作的接口请求。