一、接入流程介绍
1. 接口调用环境
接口调用地址
https://{学校 AI 课程平台域名}
2. 权限申请及开通
申请使用api,获取对应的appId与appSecret,需要联系开放平台开发后台生成
3. 接口调用方式
首先,所有接口请务必在服务端调用。严禁通过前端直接调用,防止数据泄漏!
模型注册的所有接口在使用前,需要先通过 快速开始中的生成验证token接口,使用appId与appSecret,获取临时token与env, 将两参数置于header中,访问其他接口
- 通过
appId和appSecret生成临时token与env
见 快速开始->生成验证token 接口文档
token有效期3天,3天内可重复利用,建议定期刷新token
刷新的新token不会影响旧的token,token到期会自动失效
- 将
token与env设置在 http 请求头中, 请求其他接口
Authorization: Bearer {token}
X-ENV: {env}
示例:curl https://domain/test -H 'Authorization: Bearer eyJhbGciOiJIUzI1' -H 'X-ENV: rain'
二、功能接入介绍
1.本地模型接入
调用时序图
具体接入详情,可见本地模型接入->概述
三、部分参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| appid | string | 系统分配的appid,用来换取jwt |
| appsecret | string | 系统分配的appsecret,用来换取jwt |
| nonce | string | 随机数,请自行生成,防止重放攻击 |
四、响应
- http响应码为
200表示请求正常,非200表示出现异常 - 响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码,0表示请求正确,非0表示错误,具体错误码可参考错误码 |
| data | object|array | 返回的数据 |
| message | string | 当code为非0时返回详细错误信息 |