创建应用并获取 AppKey
更新时间: 2024/12/16 11:00:37
应用是网易云信各项服务的基本业务单元,创建应用则是使用网易云信提供的产品和服务的第一步,创建的应用会被分配唯一的密钥(AppKey),用来与您的本地工程做映射关联。本文介绍如何在网易云信控制台中创建应用,以及创建后如何查看应用的凭证(AppKey 和 AppSecret)。
前提条件
创建应用前,请确保您已经在网易云信官网 注册了网易云信账号,并完成 实名认证。
注意事项
- 为了保护用户数据,应用创建后不支持删除。
- 一个账号默认最多能创建 10 个应用。如果您需要创建额外应用,请在 网易云信控制台 右上角进入 工单页面,类目选择 账号财务类 > 应用创建上限数增加申请。
- 无论是调用服务端 API 还是集成客户端 SDK,都需要使用应用的 AppKey 和 AppSecret,请务必妥善保管。由于其敏感性,建议您定期更换 AppSecret,详细步骤参考下文 刷新 AppSecret。
第一步:创建应用
-
登录 网易云信控制台。
-
进入创建页面:
-
方式一:如果您是首次登录控制台,控制台会弹出一个新手向导窗口,单击 去创建。
-
方式二:在 网易云信控制台 首页右上角,单击 创建应用。
-
-
填写应用的基本信息,如应用名称、行业类型和应用环境。
-
单击 确定 完成创建应用。
创建应用后,您可以在 网易云信控制台 首页的 应用管理 栏中查看该应用信息。
第二步:获取凭证
一旦成功创建应用,应用会被分配 AppKey 和 AppSecret。应用 AppKey 被广泛配置在项目工程或代码片段中。以 NERTC SDK init 接口为例,您可以将 appKey
参数设置为您查看到的应用 AppKey。
JavaNERtcEx.getInstance().init(context, appkey, rtcCallback, rtcOption);
NERtcEx.getInstance().setAudioProfile(NERtcConstants.AudioProfile.STANDARD, NERtcConstants.AudioScenario.MUSIC);
AppKey 和 AppSecret 是用于账号验证和授权的关键凭据,请务必妥善保管。以下为查看应用 AppKey 和 AppSecret 的步骤:
-
在 网易云信控制台 首页的 应用管理 栏中找到该创建的应用,单击应用名称。
-
在 应用配置 导航栏中,单击 AppKey 管理 页签。
-
查看该应用的 AppKey 和 AppSecret。
第三步:定期刷新
刷新 AppSecret 可以提升应用的安全性,减少潜在的恶意用户访问您的应用程序或服务的风险。
方式一:自动刷新
控制台支持一键自动刷新 AppSecret。
-
在 AppKey 管理 页签下,找到 自动刷新。
-
刷新后,您必须在本地应用代码中的 AppSecret 更新为新的 AppSecret,以确保应用继续正常运行。
方式二:手动设置
您也可以手动设置 AppSecret。
-
在 AppKey 管理 页签下,找到 手动设置。
-
手动设置 AppSecret 密钥前,将随机生成的 AppSecret 配置到您本地的业务服务器。
-
然后,单击 确定更新 使新的 AppSecret 正式生效。
同步 AppSecret
- 刷新 AppSecret 后,应用使用旧 AppSecret 加密的云服务验签将无法通过。
- 刷新 AppSecret 后,请在项目程序代码中同步修改 AppSecret 配置,避免导致程序报错。
下一步
完成应用创建后,您可以根据业务所需,开通对应的网易云信产品或方案: