跳到主要内容

创建应用

本文介绍如何在开发者中心创建应用并获取凭证。

访问开发者中心​

登录 IM 客户端后,进入 应用开发者中心。

创建步骤​

1. 点击创建应用​

在开发者中心首页,点击 创建应用 按钮。

2. 填写应用信息​

字段必填说明
appName是应用名称,如"OA办公系统"
appDescription否应用描述,简要说明应用功能
homepageUrl否应用首页地址
redirectUri否OAuth 回调地址(标准 OAuth 流程使用)
installRedirectUri否安装回调地址,用于接收安装回调

示例配置:

{
"appName": "OA办公系统",
"appDescription": "企业级办公协作平台,支持请假审批、考勤管理等功能",
"homepageUrl": "https://your-app.com",
"redirectUri": "https://your-app.com/api/im/oauth/callback",
"installRedirectUri": "https://your-app.com/api/im/install/callback"
}

3. 获取应用凭证​

创建成功后,系统会返回以下凭证:

凭证格式说明
appId数字应用 ID,如 123
clientIdUUID应用唯一标识,如 550e8400-e29b-41d4-a716-446655440000
clientSecretUUID应用密钥
botUserId数字Bot 用户 ID,如 456

响应示例:

{
"appId": 123,
"clientId": "550e8400-e29b-41d4-a716-446655440000",
"clientSecret": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"botUserId": 456
}
安全警告

clientSecret 是敏感信息,请复制保存到安全位置。

  • ❌ 禁止在前端代码中使用
  • ❌ 禁止提交到公开代码仓库
  • ✅ 仅在服务端使用
  • ✅ 使用环境变量或配置中心管理

配置说明​

installRedirectUri(安装回调地址)​

当用户在 IM 中安装您的应用时,IM 会跳转到此地址。

建议配置为后端接口,原因:

  1. 后端可以安全地保存签名信息到 Session
  2. 后端可以验证签名参数的完整性
  3. 后端可以根据业务逻辑决定重定向到哪个前端页面

回调参数:

参数说明
workspace_idIM 工作空间 ID
workspace_nameIM 工作空间名称
app_id应用 ID
initiator_user_id发起安装的 IM 用户 ID
timestamp签名时间戳(秒级)
sign签名值

回调 URL 示例:

https://your-app.com/api/im/install/callback?workspace_id=1001&workspace_name=测试工作空间&app_id=123&initiator_user_id=456&timestamp=1704528000&sign=a1b2c3d4...

redirectUri(OAuth 回调地址)​

用于标准 OAuth 授权流程,如果您的应用不需要 OAuth 授权,可以留空。

后端配置示例​

创建应用后,在您的后端服务中配置凭证:

application.yml(Spring Boot):

im:
client-id: "550e8400-e29b-41d4-a716-446655440000"
client-secret: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
api-base-url: "https://api.im.example.com"

环境变量方式:

export IM_CLIENT_ID="550e8400-e29b-41d4-a716-446655440000"
export IM_CLIENT_SECRET="7c9e6679-7425-40de-944b-e07fc1f90ae7"

下一步​

获取凭证后,您可以: