Skip to main content

创建连接器

在企业市场中创建连接器资源，提交展示信息、服务地址、传输方式、启动命令和认证配置。认证方式支持 API Key 与 OAuth，凭据保存后不再返回明文。

  • Scope：admin.v1.connectors.manage
  • 权限项：连接器管理（connectors）
  • 权限类型：管理
  • 接口：POST/api/openapi/v1/connectors

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
Idempotency-Keyheaderstring必填幂等键，用于避免重复提交"<string>"
api_keybodyOpenapifacadeConnectorAPIKeyConfig否API Key 配置-
auth_typebodystring必填授权方式"none"
category_idbodystring · uuid否分类（分类 ID）"<uuid>"
clientsbodyarray ｜ null否适用客户端["<string>"]
commandbodystring否启动命令"<string>"
descriptionbodystring否描述（英文）"<string>"
description_cnbodystring否描述"<string>"
display_namebodystring否连接器名称（英文）"<string>"
display_name_cnbodystring否连接器名称"<string>"
icon_upload_idbodystring · uuid否资源图标（上传会话 ID）"<uuid>"
icon_urlbodystring · uri否资源图标（URL）"<string>"
oauth_client_registrationbodystring否OAuth 客户端注册配置"dcr"
oauth_scopesbodystring否OAuth Scopes"<string>"
server_keybodystring必填唯一标识"<string>"
transportbodystring必填传输协议"http"
urlbodystring否服务地址"<string>"

api_key 字段

字段类型必填说明
header_namestring是传递 API Key 的请求头名称
value_prefixstring否API Key 值的前缀

请求示例

curl --request POST \
  --url 'https://example.invalid/api/openapi/v1/connectors' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
  "api_key": {
    "header_name": "<string>",
    "value_prefix": "<string>"
  },
  "auth_type": "none",
  "category_id": "<uuid>",
  "clients": [
    "<string>"
  ],
  "command": "<string>",
  "description": "<string>",
  "description_cn": "<string>",
  "display_name": "<string>",
  "display_name_cn": "<string>",
  "icon_upload_id": "<uuid>",
  "icon_url": "<string>",
  "oauth_client_registration": "dcr",
  "oauth_scopes": "<string>",
  "server_key": "<string>",
  "transport": "http",
  "url": "<string>"
}'

响应

201 Created

名称类型必填说明示例
api_keyOpenapifacadeConnectorAPIKeyConfig否API Key 配置-
auth_typestring是授权方式"<string>"
clientsarray ｜ null是适用客户端["<string>"]
commandstring否启动命令"<string>"
created_atstring · date-time是创建时间"2026-08-27T10:00:00Z"
descriptionstring否描述（英文）"<string>"
description_cnstring否描述"<string>"
display_namestring否连接器名称（英文）"<string>"
display_name_cnstring否连接器名称"<string>"
icon_urlstring否资源图标（URL）"<string>"
idstring是连接器 ID"<string>"
oauth_client_registrationstring否OAuth 客户端注册配置"<string>"
oauth_scopesstring否OAuth Scopes"<string>"
originstring是归属"<string>"
revisioninteger · int64是版本号，用于并发更新校验0
server_keystring是唯一标识"<string>"
source_typestring否来源类型"official"
statusstring是启用状态"<string>"
transportstring是传输协议"<string>"
updated_atstring · date-time是更新时间"2026-08-27T10:00:00Z"
urlstring否服务地址"<string>"
versionstring否版本"<string>"

api_key 字段

字段类型必填说明
header_namestring是传递 API Key 的请求头名称
value_prefixstring否API Key 值的前缀
{
  "api_key": {
    "header_name": "<string>",
    "value_prefix": "<string>"
  },
  "auth_type": "<string>",
  "clients": [
    "<string>"
  ],
  "command": "<string>",
  "created_at": "2026-08-27T10:00:00Z",
  "description": "<string>",
  "description_cn": "<string>",
  "display_name": "<string>",
  "display_name_cn": "<string>",
  "icon_url": "<string>",
  "id": "<string>",
  "oauth_client_registration": "<string>",
  "oauth_scopes": "<string>",
  "origin": "<string>",
  "revision": 0,
  "server_key": "<string>",
  "source_type": "official",
  "status": "<string>",
  "transport": "<string>",
  "updated_at": "2026-08-27T10:00:00Z",
  "url": "<string>",
  "version": "<string>"
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}