connector-catalog-public@1.0.0
公开连接器目录
查看 Apus 已发布的连接器类型及其就绪程度。无需身份验证。
基于已冻结的契约版本 1.0.0 生成。已冻结的版本永不修改。
操作
get/v1/public/connectors
一次返回完整目录，不分页。携带已保存的 ETag 发送 If-None-Match，目录未变化时返回 304。
无需身份验证 · getPublicConnectorCatalog
参数
| 名称 | 位置 | 类型 | 必填 |
|---|---|---|---|
| If-None-Match | header | string | 否 |
响应
200— 当前目录。空数组有效，表示尚未发布任何类型。304— 自您发送的 ETag 以来目录未变化。500— 无法生成目录。请视为暂无数据，切勿显示为空目录。
数据模型
ConnectorCatalog
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| contract | "connector-catalog-public/1.0.0" | 是 | 当前提供的契约版本。 |
| generated_at | string (date-time) | 是 | 目录生成时间（UTC，RFC 3339）。 |
| connectors | PublicConnector[] | 是 | 所有已发布类型，可能为空。 |
PublicConnector
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 连接器类型的永久标识，可安全用作链接锚点。 |
| name | string | 是 | 显示名称，请勿用于匹配。 |
| direction | inbound_api | webhook_out | polling_adapter | 是 | 数据方向：通过 API 流入、通过签名 Webhook 流出，或定期拉取。 |
| status | live | beta | roadmap | 是 | 就绪程度：live、beta 或 roadmap。 |
| summary | string | 否 | 可选的简短说明。 |
| docs_url | string (uri) | 否 | 该类型的公开文档页面（可选）。 |