迅琰网络科技 Logo提交需求 ↗
XUNYAN OPEN PLATFORM

开放平台

通过受控 API，连接大模型工具与企业软件，让内容维护进入统一审核与发布流程。

开始接入 ↗下载 OpenAPI 文档下载接入指南 ↓

API 访问地址

内容维护 API · v1https://www.kmxywlkj.com/api/integrations/v1

管理员在官网后台“API 接入”分配应用密钥、权限和有效期。请在调用方服务端安全配置密钥；本页仅提供公开文档。

这是官网内容维护接口。大模型通过获准的工具执行环境调用，其他软件通过服务端调用；业务接口均需要鉴权。

选择接入平台与能力

选择使用的平台和需要的 API 能力，下载对应说明及接口文档。各平台共用官网 API、审核与数据联动规则。

Codex / GPT · 受控工具或服务端接入

  1. 在已授权的 Codex 工具环境或 GPT 应用服务端读取 OpenAPI 和接入指南，按所选能力实现 HTTP 调用。Codex 与 GPT Actions 的配置方式不同，JSON 文档不等于可安装插件。
  2. 将官网应用密钥保存在工具执行端的环境变量或凭据管理中。先调用 GET /me，再调用获授权的读取接口；不要把密钥写入提示词。
  3. 如使用 GPT Actions，需另按其控制台校验 OpenAPI、HTTPS 和 Bearer 配置；当前官网未提供 MCP 或 OAuth 服务。

只包含 GET 接口。维护 API 可能返回获授权草稿，不能直接作为访客公开数据源。

下载所选平台接入指南下载所选能力 OpenAPI

当前下载：Codex / GPT · 读取与查询

选择文档不会授予权限或自动建立连接

所有平台的应用密钥均由官网后台管理。平台账号导入和真实调用需单独联调；先核对 /me 权限。写入继续使用版本、幂等、扫描与审核流程；大文件由可信服务端流式上传。

三步完成接入

  1. 获取授权

    联系管理员创建独立应用，选择所需权限；密钥通过安全渠道交付，不写入前端或提示词。

  2. 验证连接

    在安全运行环境设置 XUNYAN_API_TOKEN；本地预览另将上方完整地址设为 XUNYAN_API_BASE。调用 GET /me 确认应用和权限。

    curl --fail-with-body "https://www.kmxywlkj.com/api/integrations/v1/me" \
  -H "Authorization: Bearer $XUNYAN_API_TOKEN"
  3. 读取首批数据

    示例需要 articles:read。按响应游标继续分页；需要写入时，先阅读权限、版本与幂等说明。

    curl --fail-with-body "https://www.kmxywlkj.com/api/integrations/v1/articles?limit=25" \
  -H "Authorization: Bearer $XUNYAN_API_TOKEN"

在接口导入工具中使用 OpenAPI JSON，选择 Bearer 认证；真实密钥只配置在可信服务端。未提供网页在线调试器。

接口目录

与现有维护 API 共用接口定义，当前文档版本 1.2.0。各类型的必填字段、请求结构及方法以 完整 OpenAPI 文档 为准。

内容类型路径操作
文章动态/articles读取、新建、编辑、送审、审核通过
产品/products读取、新建、编辑、送审、审核通过
培训与开发服务/services读取、新建、编辑、送审、审核通过
解决方案/solutions读取、新建、编辑、送审、审核通过
客户案例/cases读取、新建、编辑、送审、审核通过
AI 资源/resources读取、新建、编辑、送审、审核通过
公开知识/knowledge读取、新建、编辑、送审、审核通过
官网导航/navigation读取、新建、编辑、送审、审核通过
首页轮播/slides读取、编辑、送审、审核通过
首页业务模块/business-modules读取、编辑、送审、审核通过
媒体/media读取、登记、上传、官网扫描、审核
产品发行/product-releases版本、附件、送审、审核、撤回
智能体任务/tasks读取、领取、提交差异

内容路径支持 GET 列表、GET /{id}、PATCH /{id}、POST /{id}/submit 和 POST /{id}/approve；可新建类型还支持 POST。/me 返回当前应用身份；任务差异提交仍须后台人工审核。

权限与数据消费

密钥管理始终留在后台

创建、轮换、停用、有效期和范围调整都由后台管理员处理。公开文档不包含真实密钥、应用列表、调用记录或未发布业务内容。

按资源授予 :read、:write、:submit、:approve；写入、送审和审核通过还须同组读取权限。媒体和任务使用各自授权范围。公开知识仅限公开知识域，客户、内部知识及账号不在此开放目录。

  1. API 创建或编辑草稿
  2. 版本记录与审计
  3. 送审及既有业务校验
  4. 后台或获授权应用审核
  5. 公开列表、详情、SSR 与搜索

编辑已公开内容会撤回为草稿，重新审核后才恢复。授权不替代正文、截图、案例授权、资料来源和扫描条件。维护 API 可读取获授权草稿，外部公开展示应使用 /api/public/* 的已审核投影。

后台通过“刷新内容数据”或各模块刷新读取更新；API 接入页重新进入或刷新读取调用情况。没有跨客户端实时推送。平台未提供 OAuth、MCP 服务端、webhook 或跨域 CORS。

分页、并发与安全重试

  • 内容与媒体列表返回 {items,hasMore,nextCursor}。limit 1–100，默认 25；cursor 原样传递，按 id 去重。任务列表不使用此分页约定。
  • 详情返回 ETag。修改、送审、审核通过须携带完整 If-Match（含双引号）；冲突时先读取并合并，避免覆盖他人的修改。
  • 独立写操作使用不同的 Idempotency-Key（16–128 位），同一操作重试复用原值，有效期 24 小时。
  • 每应用最多 120 次/分钟、1000 次写操作/24 小时。429 时遵守 Retry-After；断网后先确认状态，避免重复创建。

新建文章草稿示例

需要 articles:write 和 articles:read。先生成唯一 OPERATION_ID；此调用创建草稿，后续送审/审核使用最新详情 ETag 和空请求体 {}。

curl --fail-with-body -X POST "https://www.kmxywlkj.com/api/integrations/v1/articles" \
  -H "Authorization: Bearer $XUNYAN_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $OPERATION_ID" \
  --data '{"title":"接入示例草稿","type":"技术文章","summary":"本条为接入示例，请在获得授权后创建。","body":"示例正文"}'

媒体上传与后续发布

先计算 SHA-256，再 POST /media 登记名称、类型、字节数和摘要，按 uploadUrl PUT 原始字节。上传 Content-Type 须与登记一致；重复上传返回 409，先 GET 媒体登记核实状态。

当前单文件总上限：5 GiB（5120 MiB，5368709120 字节），与后台“文件存储”配置一致，本地与腾讯云 COS 共用；配置调整后刷新页面即可获取最新值。安装包用途 deliveryKind=installer 支持该上限。图文、模板和源码包另有类型处理限制（至多 10 MiB），不代表存储总上限。文件进入隔离区后，仍须安全扫描、审核和内容关联才能公开。

应用产品与软件下载

  1. 上传截图、安装包及说明文件，保存产品草稿。待审产品可通过 POST /products/{id}/withdraw 撤回修改。
  2. 具备 media:scan 的应用调用 POST /media/{id}/scan；扫描通过后，用新 ETag 调用 POST /media/{id}/approve，需要 media:approve。请求体均为 {}。扫描器未配置返回 503，客户端扫描报告不能代替官网扫描。
  3. 产品审核公开后，创建 POST /products/{id}/releases 发行草稿，绑定既有媒体编号。资产支持安装包、使用说明和按授权选择的源码文件。
  4. 发行版本送审、审核后，公开详情展示安装包的平台、架构、版本及 SHA-256。实际下载核对大小和摘要；编辑版本会撤回下载，重存同一附件保留编号及计数。

普通 MD/TXT 使用说明选择 documentation（至多 1 MiB）；PDF/DOCX 至多 10 MiB。Windows 安装包选择 installer、MIME application/octet-stream。

新增媒体及 product-releases:* 权限须由后台单独授予，既有应用不会自动扩权。网络超时或 502 后先读原媒体 uploadedAt、大小、摘要，避免重复登记。完整示例、状态恢复及权限说明见 接入指南。

错误与排查

错误结构：{error:{code,message}}。保留响应 X-Request-ID 便于排查，日志不记录密钥或请求头。

400 请求格式错误
检查 JSON、Content-Type 和请求体大小。
401 密钥无效或已失效
检查应用状态、有效期和密钥；不要循环重试。
403 授权范围不足
由管理员核对应用权限；浏览器跨站请求仍受限制。
404 内容不存在或不可访问
检查编号与授权范围，不把不存在的内容当作空列表。
409 状态或幂等冲突
读取最新状态；不同操作使用不同幂等键。
412 内容版本冲突
重新 GET 详情，合并修改后使用最新 ETag。
422 字段或业务校验失败
按 error.code 和 error.message 修正内容或审核条件。
428 缺少版本条件
GET 详情后将完整 ETag（含双引号）放入 If-Match。
429 调用超限
遵守 Retry-After，退避重试。
503 服务或依赖暂不可用
保留请求编号；写入重试复用原幂等键。

网站导航