创建连接器
将 <BASE_URL> 替换为所在企业环境的 API 域名。
- Scope:
admin.v1.connectors.manage - 权限项:连接器管理(
connectors) - 权限类型:管理
- 接口:POST
/api/openapi/v1/connectors
认证与请求头
使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_*** |
X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
Idempotency-Key | header | string | 必填 | - | "<string>" |
api_key | body | OpenapifacadeConnectorAPIKeyConfig | 否 | - | {"header_name":"<string>","value_prefix":"<string>"} |
auth_type | body | string | 必填 | - | "none" |
category_id | body | string · uuid | 否 | - | "<uuid>" |
clients | body | array | null | 否 | - | ["<string>"] |
command | body | string | 否 | - | "<string>" |
description | body | string | 否 | - | "<string>" |
description_cn | body | string | 否 | - | "<string>" |
display_name | body | string | 否 | - | "<string>" |
display_name_cn | body | string | 否 | - | "<string>" |
icon_upload_id | body | string · uuid | 否 | - | "<uuid>" |
icon_url | body | string · uri | 否 | - | "<string>" |
oauth_client_registration | body | string | 否 | - | "dcr" |
oauth_scopes | body | string | 否 | - | "<string>" |
server_key | body | string | 必填 | - | "<string>" |
transport | body | string | 必填 | - | "http" |
url | body | string | 否 | - | "<string>" |
请求示例
cURL
curl --request POST \
--url '<BASE_URL>/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_key | OpenapifacadeConnectorAPIKeyConfig | 否 | - | {"header_name":"<string>","value_prefix":"<string>"} |
api_key.header_name | string | 是 | - | "<string>" |
api_key.value_prefix | string | 否 | - | "<string>" |
auth_type | string | 是 | - | "<string>" |
clients | array | null | 是 | - | ["<string>"] |
command | string | 否 | - | "<string>" |
created_at | string · date-time | 是 | - | "2026-08-27T10:00:00Z" |
description | string | 否 | - | "<string>" |
description_cn | string | 否 | - | "<string>" |
display_name | string | 否 | - | "<string>" |
display_name_cn | string | 否 | - | "<string>" |
icon_url | string | 否 | - | "<string>" |
id | string | 是 | - | "<string>" |
oauth_client_registration | string | 否 | - | "<string>" |
oauth_scopes | string | 否 | - | "<string>" |
origin | string | 是 | - | "<string>" |
revision | integer · int64 | 是 | - | 0 |
server_key | string | 是 | - | "<string>" |
source_type | string | 否 | - | "official" |
status | string | 是 | - | "<string>" |
transport | string | 是 | - | "<string>" |
updated_at | string · date-time | 是 | - | "2026-08-27T10:00:00Z" |
url | string | 否 | - | "<string>" |
version | string | 否 | - | "<string>" |
响应示例
{
"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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
code | string | 否 | Stable business error code | "<string>" |
detail | string | 是 | Human-readable error description | "<string>" |
details | OpenapiErrorDetails | 否 | - | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
details.field | string | 否 | Request field that failed validation | "<string>" |
details.reason | string | 否 | Stable validation failure reason | "<string>" |
details.suggestion | string | 否 | Suggested normalized value | "<string>" |
error | string | 是 | Stable HTTP error type | "<string>" |
响应示例
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}