嵌入集成(实验)

提供可供嵌入的 iframe url，可在您的系统中快速嵌入基于大模型的自然语言对话能力。

嵌入集成方案尚处于实验阶段，接口仍可能产生变更，请及时关注文档更新。

基于 SSO 的嵌入模式

适合在已经与学校统一身份认证集成的场景，通过 SSO 实现统一认证。

ChatECNU 将提供一个简化的仅包含对话部分的 iframe 页面，您可以在您的系统中嵌入这个页面，用户访问时将自动登录 ChatECNU 并进入对话。

基于令牌的嵌入模式

适合在没有与学校统一身份认证集成的场景，通过令牌的形式验证可信性，并生成一次性的访问地址供业务嵌入。

授权账号

以下 client_id 和 client_secret 部分和数据开放平台的账号一致。

client_id = your_client_id

client_secret = your_client_secret

appid = 分配给您的appid

接口描述

这个接口根据用户上传的认证信息，返回嵌入应用专用的访问地址url和地址的过期时间说明，用户可以用iframe的形式嵌入到原本应用中，需要注意的是此地址有效期内可访问一次，地址有效期过后，原有的地址也将失效，需要用户及时刷新重新获取url。

请求方式

POST

请求地址

/open/api/embed/app

content-type

application/json 或 application/x-www-form-urlencoded 皆可

请求参数

参数名	必选	类型	说明
client_id	是	string	开发者账号id
client_secret	是	string	开发者账号secret
userid	是	string	用户id, 建议传考生号
username	是	string	用户的姓名
appid	是	string	嵌入应用的appid

返回参数

参数名	类型	说明
code	int	状态码，0表示成功
message	string	描述信息
data	object	返回数据
data.ticket	string	访问嵌入应用专用的访问地址url的凭证，ticket 为一次性，地址被重复访问则会失效
data.url	string	嵌入应用专用的访问地址url ，iframe 引用这个地址即可
data.expire	int	地址有效时间，单位为秒。必须在 ticket 失效之前重新换取新的 ticket 并刷新 iframe 窗口

请求示例

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'client_id=f9xxxxxxxxx31&client_secret=b3xxxxxxxxxxxxxxxxxxxx4ff&userid=2019210301&username=张三&appid=xxxxxx' https://chat.ecnu.edu.cn/open/api/embed/app

or

curl -X POST
 -H "Content-Type: application/json" -d '{
    "client_id": "fxxxxxxxxx31",
    "client_secret": "bxxxxxxxxxxxxxxff",
    "userid": "2019210301",
    "username": "张三",
    "appid": "xxxxxx"
}' https://chat.ecnu.edu.cn/open/api/embed/app

响应数据结构

{
  "code": 0,
  "message": "ok",
  "data": {
        "ticket": "e7155001-e4da-4626-8ab0-1d26336c0e80",
        "url": "https://chat.ecnu.edu.cn/html/iframe.html?ticket=e7155001-e4da-4626-8ab0-1d26336c0e80",
        "expire": 43200
  }
}

访问此 url 将直接进入大模型对话 chat 服务。