如何获取 Easemob 开放平台 API 密钥 (分步指南)
环信是中国IM即时通讯云服务的开创者，提供包括即时通讯云、客服云、视频客服、在线客服、客服机器人等在内的全方位通讯解决方案，支持公有云、专有云等多种部署方式，服务覆盖金融、医疗、教育等多个行业。本文将指导你如何获取 easemob 开放平台 API密钥，并进行初步的可用性测试，同时探讨在使用过程中需要考虑的其他关键因素。
1. 获取 easemob 开放平台 API秘钥步骤
获取 easemob 开放平台 API密钥的过程相对简单，只需几个步骤即可完成：
1.访问官方网站注册/登录：https://console.easemob.com/user/register
2.手机号注册以后会需要填写邮箱，根据填写的邮箱去邮箱中验证。
3.邮箱验证完成以后就可以正常使用平台提供的功能。可以在控制台中查看到应用的详细信息。
4.点击对应的应用中操作栏中的管理按钮，可以查看到详细信息，例如Client ID、ClientSecret等。
2. easemob 开放平台 API密钥可用性测试
在获取API密钥后，进行可用性测试是确保其正常工作的重要步骤。以下是web端使用按需导入 SDK进行测试的一个案例
按需导入 SDK 模块
1. 安装 SDK
首先，通过 npm、yarn 或者其他包管理工具进行安装 SDK。
# npm
npm install easemob-websdk
# yarn
yarn add easemob-websdk2. 引入 SDK 和所需模块
根据项目需求引入相应的功能模块。例如，引入用户关系模块：
import MiniCore from "easemob-websdk/miniCore/miniCore";
import * as contactPlugin from "easemob-websdk/contact/contact";3. 注册模块到 miniCore
将引入的功能模块注册到 miniCore 中：
const miniCore = new MiniCore({
appKey: "your appKey",
});
// "contact" 为固定值
miniCore.usePlugin(contactPlugin, "contact");4. 使用注册的模块
注册所需模块后，即可在项目中使用这些模块提供的功能：
// 获取联系人列表
miniCore.contact.getContacts();3. 使用 easemob 开放平台 API搭建应用的其他关键考虑因素
在使用 easemob 开放平台 API搭建应用时，除了获取和测试API密钥外，还需考虑以下因素：
前提条件
- 有效的环信即时通讯 IM 开发者账号；
- 创建环信即时通讯 IM 项目并获取 App Key；
- npmopen in new window；
- SDK 支持 IE 9+、Firefox 10+、Chrome 54+ 和 Safari 6+。
提示
- 只有按需导入 SDK 的方式才支持本地会话管理功能。
- 小程序 uniapp 不支持使用 miniCore 的集成方式。
SDK 提供了灵活的模块化设计，允许开发者根据需求引入功能模块，并将其注册到 miniCore 中使用。
miniCore 是一个基座，支持登录登出和发送消息等基础功能open in new window，而且包含消息对象。因此，若只使用收发消息功能，则只需引入 miniCore。若使用其他功能，miniCore 支持使用插件的方式引入其他功能模块。按需引入模块的方式实现了不同模块的灵活组合，从而避免不必要的代码加载，减小了应用程序的体积。
支持按需导入的 SDK 模块
| 功能 | 导入文件 | 使用方式 |
|---|---|---|
| 联系人和消息管理 | import * as contactPlugin from “easemob-websdk/contact/contact”; | miniCore.usePlugin(contactPlugin, “contact”); |
| 群组 | import * as groupPlugin from “easemob-websdk/group/group”; | miniCore.usePlugin(groupPlugin, “group”); |
| 聊天室 | import * as chatroomPlugin from “easemob-websdk/chatroom/chatroom”; | miniCore.usePlugin(chatroomPlugin, “chatroom”); |
| 子区 | import * as threadPlugin from “easemob-websdk/thread/thread”; | miniCore.usePlugin(threadPlugin, “thread”); |
| 翻译 | import * as translationPlugin from “easemob-websdk/translation/translation”; | miniCore.usePlugin(translationPlugin, “translation”); |
| 在线状态订阅 | import * as presencePlugin from “easemob-websdk/presence/presence”; | miniCore.usePlugin(presencePlugin, “presence”); |
| 会话免打扰 | import * as silentPlugin from “easemob-websdk/silent/silent”; | miniCore.usePlugin(silentPlugin, “silent”); |
常见错误代码
| 错误码 | 错误信息 | 描述和可能原因 |
|---|---|---|
| 0 | REQUEST_SUCCESS | 提示操作成功，没有错误。 |
| -1 | REQUEST_TIMEOUT | 请求服务超时。 |
| -2 | REQUEST_UNKNOWN | 默认未区分类型的错误。 |
| -3 | REQUEST_PARAMETER_ERROR | 参数错误。 |
| -4 | REQUEST_ABORT | 取消请求。 |
| 1 | WEBIM_CONNCTION_OPEN_ERROR | 登录失败：获取 token 接口请求失败或 Token 无效。 |
| 2 | WEBIM_CONNCTION_AUTH_ERROR | 登录鉴权失败。 |
| 12 | WEBIM_CONNCTION_GETROSTER_ERROR | 获取 Chat token 失败：通过 Agora token 置换 Chat token 失败。 |
| 16 | WEBIM_CONNCTION_DISCONNECTED | WebSocket 断开连接：由于断网等原因 WebSocket 已经断开。 |
| 17 | WEBIM_CONNCTION_AJAX_ERROR | 服务请求的通用错误：请求服务器未成功时的默认错误。 |
| 27 | WEBIM_CONNCTION_APPKEY_NOT_ASSIGN_ERROR | 未设置 App Key：设置的 App Key 错误，登录时会报此错误。 |
| 28 | WEBIM_CONNCTION_TOKEN_NOT_ASSIGN_ERROR | 未传 token：调用 API 时没有携带 token，一般没登录时调用 API 会提示这个错误。 |
| 31 | WEBIM_CONNCTION_CALLBACK_INNER_ERROR | 消息发送回调函数内部错误：在接收消息的回调及后续处理的函数中有错误。 |
| 32 | WEBIM_CONNCTION_CLIENT_OFFLINE | 当前用户未登录。 |
| 39 | WEBIM_CONNECTION_CLOSED | 退出或未登录：未登录或掉线后发送消息。 |
| 40 | WEBIM_CONNECTION_ERROR | 用户鉴权失败。 |
| 50 | MAX_LIMIT | 达到上限，例如 Reaction 数量已达到限制、翻译用量达到上限、应用的日活跃用户数（DAU）超限、在线用户数量超限和月活跃用户数（MAU）。 |
| 51 | MESSAGE_NOT_FOUND | 没查到消息，如：没有查询到要举报的消息。 |
| 52 | NO_PERMISSION | 用户对当前操作没有权限。 |
| 53 | OPERATION_UNSUPPORTED | 不支持的操作。 |
| 101 | WEBIM_UPLOADFILE_ERROR | 上传文件失败：如文件过大等。 |
4. easemob 开放平台 API密钥申请和使用中的常见问题
在申请和使用easemob 开放平台API密钥过程中，你可能会遇到以下常见问题：
群组操作失败，提示权限不足，如何解决？
请确认您在群组中的角色是否具有相应的操作权限，例如创建者、管理员或普通成员的权限级别可能不同。您可以在官方文档中查找关于群组权限的详细说明。
如何处理用户被踢下线的情况？
当同一用户在其他设备登录，或用户密码被修改时，可能会导致当前设备的用户被踢下线。请确保未在其他设备上重复登录，或在密码修改后重新登录。
为什么用户登录时提示鉴权失败？
这可能是由于 App Key 设置错误、用户凭证无效或网络问题导致的。请确保在初始化 SDK 时使用了正确的 App Key，并验证用户的用户名和密码是否正确。
5.easemob 开放平台API进阶指引
在获得 easemob 开放平台API密钥之后，即可开启对接，本文整理了多篇使用 easemob 开放平台 案例，帮助读者更有效地使用
发送和接收消息、管理本地会话、管理用户属性、管理用户关系、创建和管理群组及监听群组事件
6. 常见问题
问题1： 什么是幂简集成平台？
幂简集成是蜜堂有信在2023年打造的一款SAAS产品，建设着国内最全的API平台，为开发者提供全面、高效、易用的API集成管理方案，一站搜索、试用、集成国内和国外API。让用户在AI时代全方位接入互联网，用API连接一切服务和算力，实现价值倍增。
问题2：如何找到 easemob 开放平台 API
幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’ easemob 开放平台 API‘这类品类词，更容易找到结果)、或者从API hub分类页进入寻找。
问题3： easemob 开放平台 API的替代品有哪些？
市场上存在免费、付费两种替代者
例如
更多竞品可以在 easemob 开放平台 找到。
7. 总结
本文介绍了获取 easemob 开放平台 API密钥的步骤，从账号注册到获取到appKey等关键信息，同时提供了通过按需导入 SDK 进行可用性测试的具体案例，并探讨了在集成过程中需要注意的事项。还针对申请和使用API密钥时的常见问题提供了解决方案，并总结了 API 的实际应用场景及相关进阶使用方法，为开发者有效利用easemob开放平台提供了全面的指导。
