🔌 YingCore 系统对接指南

👤 适合谁: 开发者、需要把平台能力接入自有系统的用户

⏱️ 阅读时长: 约 8 分钟

💡 一句话: 用 OpenAI 协议统一调用平台全部模型。

YingCore 提供 OpenAI 兼容 的 API，你可以用任意支持 OpenAI 协议的语言 / SDK 对接，统一调用平台已配置的全部模型。

一、申请 API Key

1. 登录平台 → 顶部 「获取API」。
2. 在 API Key 区域点击 「创建」 生成平台 Token。
3. 复制保存 Key 与 Base URL：
   • Base URL：https://你的平台地址/platform-api/v1
   • API Key：你的API_KEY

Key 仅在创建时可完整查看，请立即保存。Key 属于敏感凭据，请妥善保管。

二、查看可用模型

调用前可先拉取模型列表确认可用的模型 ID：

GET https://你的平台地址/platform-api/v1/models
Authorization: Bearer 你的API_KEY

返回每个模型的 模型 ID、供应商、类型、上下文长度、能力标签 等。对话时 model 字段填列表中的模型 ID。

三、四语言对接示例

Python

from openai import OpenAI

client = OpenAI(
    base_url="https://你的平台地址/platform-api/v1",
    api_key="你的API_KEY",
)
resp = client.chat.completions.create(
    model="deepseek-chat",
    messages=[{"role": "user", "content": "你好"}],
)
print(resp.choices[0].message.content)

cURL

curl https://你的平台地址/platform-api/v1/chat/completions \
  -H "Authorization: Bearer 你的API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"deepseek-chat","messages":[{"role":"user","content":"你好"}]}'

Node.js

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://你的平台地址/platform-api/v1",
  apiKey: "你的API_KEY",
});

const resp = await client.chat.completions.create({
  model: "deepseek-chat",
  messages: [{ role: "user", content: "你好" }],
});
console.log(resp.choices[0].message.content);

Java

import com.theokanning.openai.OpenAiService;
import com.theokanning.openai.completion.chat.*;

// baseUrl 指向平台
OpenAiService service = new OpenAiService("你的API_KEY", Duration.ofSeconds(60));
// 配置 baseUrl: https://你的平台地址/platform-api/v1

各语言均以 OpenAI 官方 SDK 协议对接，仅需修改 base_url 与 api_key。具体类名请以你所用 SDK 版本为准。

四、向客户端下发 API 配置

「获取API」页面提供 下发 API 能力，用于让已注册客户端（如 YingClaw）一键使用平台模型：

1. 在「下发API」区域选择目标客户端设备（按用户邮箱筛选）。
2. 拉取全局 / 用户配置。
3. 点击 「快速填充」，自动写入：
   • api_key：分配给客户端的 Key。
   • default_provider：custom:http://122.114.233.81/platform-api/v1/chat/completions（以实际为准）。
   • default_model：如 deepseek-chat。
4. 点击推送到客户端，客户端即完成对接。

五、嵌入（Embed）外部站点

若希望把平台的对话助手嵌入你的网站：

1. 在 「工作台」 应用卡片菜单选择 「嵌入站点」。
2. 生成 iframe 嵌入代码（/chat/share?shared_id=...），可配置隐藏头像、语言等。
3. 将代码粘贴到你的网页即可。

部分嵌入模式（部分嵌入/浏览器扩展）标注为"即将上线"。

六、对接注意事项

• 协议：与 OpenAI 协议兼容，已有 OpenAI 代码改动最小。
• 鉴权：请求头 Authorization: Bearer <API_KEY>。
• 用量：可在「获取API → 用量统计」查看调用次数与 Token 消耗；管理员可在「YingClaw」中按用户/租户查看用量。
• 限流：如遇限流或配额问题，请联系平台管理员调整。
• 模型可用性：模型以「模型提供商」中配置并启用的为准；未配置的模型无法调用。