接入指南
欢迎接入我们!通过本指南,你可以快速通过后端服务器对接 AI-Champion,获取最新的课程列表及分发系统激活码,并引导你的用户免密观看。
鉴权准备
在发起任何接口请求之前,请确保你已经在请求首部 (Header) 中附加了我们为你下发的 API 密钥。
x-api-key: pk_test_xxxxxxx1. 获取在售课程列表
你可以调用此接口定时同步我们的最新课程库。接口将返回所有处于“已上线”状态的课程信息及营销海报。
GET/api/partner/courses
Request Example (cURL)
curl -X GET https://xueai.site/api/partner/courses \ -H "x-api-key: YOUR_PARTNER_API_KEY"
Response (200 OK)
[
{
"id": "a3JUeZG9wGFwNRBjftX3H",
"name": "Microsoft Azure AI-900 认证突击营",
"description": "零基础直达 AI-900... (可选)",
"imageUrl": "/images/1773024823_a1b2c3d.png", // 相对路径
"fullImageUrl": "https://xueai.site/images/1773024823_a1b2c3d.png" // 完整免拼装直接可用的海报链接
}
]2. 询价及获取价格策略
当用户在你们的平台发起购买时,你需要将用户支付的金额传给我们,系统会通过定义的阶梯规则自动寻址对应的课程,并动态计算出该笔订单的结算价返回给你。
POST/api/partner/query
Request Payload (JSON)
{
"amount": 1000 // 用户实际支付的金额 (用于适配后台设置的阶梯价格规则)
}Response (200 OK)
{
"success": true,
"finalPrice": 500, // 系统根据商户定价规则折算出的最终结算价
"course": {
"id": "a3JUeZG9wGFwNRBjftX3H", // 重要:在下一步生成激活码时需要使用此内容
"name": "Microsoft Azure AI-900 认证突击营",
"description": "...",
"imageUrl": "/images/1773024823_a1b2c3d.png", // 相对路径
"fullImageUrl": "https://xueai.site/images/1773024823_a1b2c3d.png" // 完整免拼装直接可用的海报链接
}
}3. 确认购买并生成授权链接
当你在自己的平台处理完收费后,将询价接口拿到的课程 ID 与该订单的 ID 同步过来,以正式签发课程授权(免手工登录发码)。
POST/api/partner/generate-code
Request Payload (JSON)
{
"courseId": "a3JUeZG9wGFwNRBjftX3H", // 从上一步询价接口获取的课程ID
"uid": "order-89757" // 贵平台的真实订单号,以便对账及售后追踪
}Response (200 OK)
{
"success": true,
"code": "3F9E1A2B", // 激活码(如需短信下发则可用该字段)
"courseId": "a3JUeZG9wGFwNRBjftX3H",
"accessLink": "https://xueai.site/courses/a3JUeZG9wGFwNRBjftX3H?uid=user-89757"
}4. 最佳实践引导流程
后端隐式请求发码及询价
强烈建议在贵方后端服务器完成 POST /api/partner/query 与 POST /api/partner/generate-code 前后端两次调用。请不要在客户端/小程序端将 Header 的 API 密钥暴露给用户。
利用 accessLink 实现“一键免登陆”体验
拿到接口返回的 accessLink 后,直接向用户展示一个“开始观看”的按钮并跳转至该链接即可。
这个带 URL Parameter(即 ?uid=...)的链接,会自动判断用户是否使用了这张网卡或激活资格。如果是首次打开,用户只需点击一个弹窗的确认按钮;第二次及以后打开将直接进入视频大纲。