Appearance
注册应用并接入
组织应用是你自己开发、自己部署的网站——机灵兔客户端只负责把它内嵌打开, 并给它提供免登身份和一组开放能力。你需要自己准备好可公网访问的 https 页面 (本地开发调试可用 http://localhost)。
不知道需要哪些能力?先看能力地图——按"我想做的事" 找到对应能力和最小路径再回来。
1. 注册应用
登录机灵兔客户端,进入「组织」→ 选择你的组织 →「应用」→「新建应用」,填写:
- 应用名称:成员会在工作台里看到这个名字
- 页面地址:你自己部署的网站首页 URL(正式环境必须是
https://) - 开放能力:勾选这个应用需要用到的能力(见能力说明), 免登身份不用勾选,恒定授予
创建后会拿到一对凭证:
| 凭证 | 用途 | 保存方式 |
|---|---|---|
AppKey | 标识应用 | 可以写进你的后端配置 |
AppSecret | 换取 app access token | 只能放在你的服务器上,绝不能出现在页面/客户端代码里 |
2. 在页面里引入 JSAPI
html
<script src="https://<你的机灵兔部署域名>/api/open/jsapi/jlt.js"></script>推荐搭配平台提供的 TypeScript 封装(可选,纯类型 + Promise 化,不引入额外协议; 包尚未发布到 npm 时,直接用全局 window.jlt 也完全可行,见 JSAPI):
bash
pnpm add @ai-im/org-app-sdkts
import { isInJltClient, ready, parseLaunchParams } from "@ai-im/org-app-sdk";
if (isInJltClient()) {
const ctx = await ready();
console.log(`你好,${ctx.user.nickname}`);
}3. 免登:换取当前用户身份
客户端打开应用时,会把一次性授权码拼在页面 URL 上:
https://your-app.example.com/?jlt_auth_code=xxx&jlt_org_id=xxx&jlt_app_id=xxx把它交给你自己的后端,用 POST /api/open/auth/user 换取用户身份(详见免登与鉴权)。
4. 调用开放能力
拿到 app access token 后,即可调用你在第 1 步勾选的开放能力接口 (通讯录/消息/AI/知识库检索),详见开放 API 参考。 三种语言的完整可运行示例(curl / Node.js / Python)见完整示例。
5. 发布到应用市场(可选)
在「应用」详情里点「上架市场」,选择可见范围(默认所有组织可见)。其他组织 的管理员可以在「应用市场」里找到并安装,安装后需要单独授予能力——这是 两件独立的事:上架只是让别人看见,授权才是让能力真正生效。详见 应用市场发布。