跳到主要内容

获取 API

📖 适合谁:开发者 / 集成方 / 平台管理员 —— 想用 OpenAI 兼容协议把 YingCore 模型嵌进自己的系统、产品或小程序的人

📖 阅读时长:4 分钟

📖 一句话:YingCore 对外开放的统一接口层,让你的系统 / 应用 / 小程序用 OpenAI 兼容协议直接调用 YingCore 平台已配置的全部模型,模块同时提供 API Key 管理、OpenAPI 文档、多语言 SDK、流式响应、配额限流、Webhook 回调。顶部导航「获取 API」(路由 /platform-api-console) 进入,全员可访问,支持 OpenAI 兼容 + 原生 REST 协议,完整细节见 系统对接指南。

一、核心价值​

价值点说明
协议兼容OpenAI 兼容接口 — 现有基于 OpenAI SDK 的代码只需改 base_url + api_key 即可接入,零迁移成本
一站式从「Key 签发 → 文档查阅 → 代码调用 → 配额管控 → 账单核对」全流程在一处完成,无需跳多个系统
企业级mTLS 双向认证、字段级脱敏、审计日志、IP 白名单、过期时间 — 满足生产环境合规要求
可观测每个 Key 的调用量、Token 消耗、费用、错误率实时可视化,支持账单导出
可扩展多语言 SDK、流式响应、Webhook 回调 — 支撑从「实时对话」到「百万级离线批处理」的全部规模

二、主要能力​

1. API Key 管理​

  • 在工作台为每个应用、每个开发者签发独立的 API Key,支持 按 Key 设置权限范围、IP 白名单、过期时间。
  • 列出 / 创建 / 删除平台 Token,一键复制 Key。
  • 配套 安全合规:支持 mTLS 双向认证、字段级脱敏、审计日志追溯。
  • ⚠️ Key 是敏感凭据 — 关闭或刷新后可能无法再次查看明文,请妥善保管。

2. OpenAI 兼容接口​

  • 提供 标准 OpenAI 协议 的 Base URL:https://你的平台地址/platform-api/v1。
  • 用 OpenAI SDK 把 base_url 指向平台地址,api_key 填入你的 Key,即可调用平台已配置的全部模型。
  • 用 Token 调用 /platform-api/v1/models 端点可拉取平台可用模型列表,每个模型展示:模型 ID、供应商、类型(chat / embedding / rerank / image2text / tts / speech2text / ocr)、原始模型名、上下文长度、能力标签(视觉 / 工具调用 / 推理 / 图片生成 / 多模态等)、是否支持工具调用。
  • 零迁移成本 — 绝大多数基于 OpenAI SDK 的现有代码只需改 2 个参数即可接入。

3. 完整 OpenAPI 文档​

  • 对话、数字员工、工作流、知识库、图谱 等所有平台能力都有标准 REST 接口文档。
  • 自带 Swagger UI 在线调试 — 在文档页直接填参、试调、看响应,无需本地搭环境。
  • 每个端点标注:请求方法、路径、参数、鉴权方式、响应结构、错误码、调用示例。

4. 多语言 SDK​

  • 官方提供 Python、Node.js、Java、Go 四语言 SDK。
  • 封装 鉴权、重试、流式响应 等通用细节,业务代码只关心业务逻辑。
  • 附带平台特有能力的封装(数字员工调用、工作流触发、向量检索等),不用裸调 REST。

5. 流式响应(SSE / WebSocket)​

  • 大模型对话支持 流式输出 — 模型一边生成一边返回,实现 实时打字机效果,无需等完整响应。
  • 同时提供 SSE(Server-Sent Events) 和 WebSocket 两种协议,适配不同前端架构。
  • 流式过程中可中断、重连、累计 Token 用量,便于前端做「停止生成」交互。

6. 配额与限流​

  • 按 Key 设置 QPS、日配额、月配额、并发上限。
  • 超额自动 熔断 并返回明确错误码(429 Too Many Requests / 自定义业务码),前端可友好提示。
  • 支持 按团队 / 项目 / 应用 多级配额分配,管理员可统一管控全平台资源。

7. 调用统计与计费​

  • 每个 Key 的 调用量、Token 消耗(输入 / 输出)、费用、错误率 实时可视化。
  • 按 时间维度(小时 / 天 / 月)、模型维度 交叉统计,定位成本热点。
  • 账单可导出(Excel / CSV),对接企业财务系统。

8. Webhook 回调​

  • 异步任务(工作流执行、批量导入、批量总结等)完成时 主动推送结果 到指定 URL,无需轮询。
  • 支持 签名验证(HMAC)、重试策略(指数退避)、死信队列(多次失败后归档)。
  • 配合流式响应,既能实时交互,又能离线跑大批量任务。

三、典型应用场景​

场景 1:集成到自研 App​

开发者用 Python SDK 3 行代码 把大模型对话能力嵌进自己的 App:

from yingcore import YingCore
yc = YingCore(api_key="你的KEY")
resp = yc.chat.completions.create(model="deepseek-chat", messages=[{"role":"user","content":"你好"}])
print(resp.choices[0].message.content)

无前端、无运维、对个人开发者最友好,几分钟就能跑通第一个 demo。

场景 2:嵌入业务系统​

在 CRM、ERP、工单系统 里加一个「AI 总结」按钮,点击后调 YingCore API 总结当前工单 / 客户画像 / 合同条款,结果直接渲染在页面。整个交互 < 3 秒,业务人员无需切换工具,大幅提升工作效率。

场景 3:小程序智能客服​

微信小程序 通过 HTTPS 调 YingCore,数字员工 自动回复用户咨询。流式响应让用户感受到「边输入边出字」的实时感,Webhook 回调把高价值对话归档到 CRM。

场景 4:批量离线任务​

调 API 触发 10 万条工单的批量总结,API 立即返回 task_id,实际处理在平台后台跑;完成后通过 Webhook 回调 推送结果,业务系统接收后再做归档、报表生成。整个过程无需业务系统轮询,资源占用降到零。

场景 5:跨团队配额管理​

给 A 团队 100 万 Token / 月、B 团队 50 万 Token / 月 的独立配额;超额自动熔断、邮件告警,避免单个团队的失控消耗拖垮全平台。管理员统一看 全平台用量大盘,提前做资源扩容或成本分摊。

四、使用指南​

第 1 步:申请 API Key

  1. 顶部导航点击 「获取API」,进入控制台。
  2. 在 API Key 管理 区域点击 「创建」,设置 Key 名称、权限范围、IP 白名单、过期时间。
  3. 点击 「复制」 保存 Key(关闭或刷新后可能无法再次查看明文)。

第 2 步:查阅 OpenAPI 文档

  1. 在控制台点击 「API 文档」 进入 Swagger UI。
  2. 选择要对接的能力(对话 / 数字员工 / 工作流 / 知识库 / 图谱)。
  3. 在文档页直接试调,确认参数和响应结构。

第 3 步:对接调用

  1. 简单场景:用 OpenAI SDK,把 base_url 改成平台地址,api_key 填你的 Key,直接调。
  2. 复杂场景:用官方 SDK(Python/Node.js/Java/Go),封装鉴权 / 重试 / 流式。
  3. 流式需求:选择 SSE 或 WebSocket 协议,前端做「打字机」效果。
  4. 异步任务:提交时指定 webhook_url,任务完成后平台主动推送结果。

第 4 步:监控与运维

  1. 在 调用统计 区域看每个 Key 的用量、费用、错误率。
  2. 在 配额管理 区域调整 QPS / 日 / 月配额上限,设熔断告警。
  3. 导出账单对接财务系统,定期审计敏感操作的审计日志。

五、最佳实践​

  • 协议兼容优先 — 简单集成用 OpenAI SDK,改 2 个参数即可;只有在 SDK 无法覆盖的边缘场景(自定义 webhook 签名、mTLS 双向认证)才用原生 REST。
  • Key 隔离 — 不同环境(开发 / 测试 / 生产)、不同应用、不同团队 用独立 Key,便于权限隔离、用量追溯、问题定位;不要一个 Key 走天下。
  • Key 保管 — 生产 Key 不要明文暴露在前端页面或代码仓库;用环境变量 / 密钥管理服务(KMS)注入,定期轮换。
  • 配额监控 — 给生产 Key 设 日 / 月配额上限 和 告警阈值(如 80%),防止失控消耗;超额熔断比欠费停服好得多。
  • 流式优于轮询 — 用户能感知的对话场景用 流式响应;只有「用户已离开页面」的后台任务才用同步等待。
  • 异步用 Webhook — 批量任务(> 100 条)、耗时任务(> 5 秒)优先用 Webhook 回调 拿结果,不轮询;签名验证 + 死信队列 保证不丢任务。
  • 安全合规 — 生产环境开 mTLS 双向认证、敏感字段(手机号 / 身份证)开 字段级脱敏、管理员操作开 审计日志。
  • 错误处理 — 客户端必须处理 429 配额耗尽、401 Key 失效、5xx 平台异常三类错误,提供友好降级(排队等待 / 提示刷新 / 切换备用 Key)。