====== 已上线应用的用户体系导入到环信 ======

---- 

===== 集成概述 =====

环信和用户体系的集成主要发生在2个地方，服务器端集成和客户端集成。参考 [[ccim:rest:accountsystem|用户体系集成 REST API]]。

{{ ::image001.png?nolink |}}

===== 用户体系导入环信 =====
环信只是即时通讯的消息通道。环信本身不提供用户体系，环信既不保存任何 APP 业务数据，也不保存任何 APP 的用户信息。比如说，你的 APP 是一个婚恋交友 APP，那么你的 APP 用户的头像、昵称、身高、体重、三围、电话号码等信息是保存在你自己的 APP 业务服务器上，这些信息不需要告诉环信。

环信这样设计的目的有2个：

  * 尽量少的侵入开发者自己 APP 的业务数据和用户体系。用户体系是一个 APP 的最最核心的数据，在当前中国的环境下，部分开发者会比较难信赖一个第三方厂商，把自己最关键的用户体系信息托管到一个第三方平台上。
  * 大多数 APP 都有自己的服务器后台，有自己的用户体系。所以环信要尽力做好的环节是尽可能方便开发者把环信和自己的用户体系集成，而不是为开发者提供他们可能并不会用的用户体系。
要使用环信，只需要为每一个 APP 用户创建一个环信账号。创建环信账号仅需要以下信息：
^名称	^字段名	^数据类型	^描述^
|环信 ID	|username	|String	|在 AppKey 的范围内唯一用户名，也是第三方用户体系中的 primarykey。|
|用户密码	|password	|String	|用户登录环信使用的密码。为保证第三方用户体系中的账号密码不必要的泄露给环信，建议对第三方用户体系的账号密码做一次 hash 算法。然后在手机端登录环信时，客户端同样使用 hash 后的密码登录。|

==== 服务器端集成 ====

**将已上线的 APP 的现有用户集成到环信** [[ccim:rest:accountsystem|用户体系集成 REST API]] 提供了一个创建环信账号的 REST 方法。这个方法很简单，只需要提供账号 ID 和密码 2 个参数，就可以创建一个环信账号。对一个已经上线，已经有很多现有用户的 APP 来说，要集成环信，只需要写一个脚本，循环调用创建环信用户的 REST 方法即可。
环信账号中的 username 可以和已有的 APP 用户体系的用户的 primarykey 相同。这样做的好处是不需要对现有 APP 后台的数据库的用户表做任何修改（比如不需要给用户表增加一个叫环信账号 ID 的字段）。

**APP 创建新用户时创建环信账号 **为保证安全，强烈建议只在服务器端调用创建环信账号的 REST 方法。具体方法见 [[ccim:rest:accountsystem|用户体系集成 REST API]]。即每次当APP客户端调用APP自己的业务后台创建新用户时，也在环信上为该 APP 用户创建一个环信账号。
通常的做法是在自己 APP 创建用户成功后调用创建环信账号的 REST 方法来创建环信账号。因为这个方法是服务器对服务器的调用，所以因为网络不稳定原因失败的可能很小。但开发者仍旧需要对该方法的返回结果做处理，如果该方法失败，应该做个 retry，如果仍旧失败，应该回滚在自己 APP 创建用户的操作。否则会导致 APP 的用户账号和环信账号不一致的问题。

**APP 删除用户时删除环信账号**为保证安全，强烈建议只在服务器端调用删除环信账号的 REST 方法。具体方法见 [[ccim:rest:accountsystem|用户体系集成 REST API]]。即每次当APP客户端调用 APP 自己的业务后台删除新用户时，也在环信上将该 APP 用户对应的环信账号删除。

**APP 修改用户密码时更新环信账号的密码**为保证安全，强烈建议只在服务器端调用修改环信账号密码的 REST 方法。具体方法见 [[ccim:rest:accountsystem|用户体系集成 REST API]]。即每次当 APP 用户的密码被修改时，也要更新该 APP 用户对应的环信账号的密码。

==== 客户端集成 ====

**客户端登录集成** APP 客户端在登录自己的 APP 服务器后台成功后，需要调用环信客户端 SDK 的登录方法。

**客户端退出登录集成** APP 客户端在退出登录自己的 APP 服务器后台成功后，需要调用环信客户端 SDK 的退出登录方法。

===== 好友体系导入环信 =====

所谓好友体系，是指谁是谁的好友的关系体系。环信提供好友体系，但不是必须使用的。
==== 服务器端集成 ====

APP 可以将现有 APP 的好友关系导入到环信的好友体系中。

**将已上线的 APP 的现有用户的好友体系导入到环信**好友列表管理 REST API 提供了一个修改环信账号好友体系的 REST 方法。对一个已经上线，已经有很多现有用户的 APP 来说，只需要写一个脚本，循环调用修改环信账号好友体系的 REST 方法即可。

**APP 用户好友列表更新时也同步更新环信账号的好友体系**好友列表管理 REST API 提供了一个修改环信账号好友体系的 REST 方法。即每次当 APP 业务后台的用户的好友列表发生变化时，也在环信上更新该 APP 用户的好友体系。

==== 客户端集成 ====

通常来说，“将已上线的 APP 的现有用户的好友体系导入到环信”这个是在 APP 的服务器端做的。但“APP 用户好友列表更新时也同步更新环信账号的好友体系”这个操作则根据 APP 具体的业务场景，既可以在服务器端做，也可以在客户端做。

**iOS 客户端操作好友列表**

  * 获取好友列表，监听好友列表
  * 根据账号（查找、添加、删除，黑名单）

**Android 客户端操作好友列表**

  * 好友列表管理



----
<WRAP group>
<WRAP half column>
上一页：[[im:other:integrationcases:robmic|抢麦模式]]
</WRAP>

<WRAP half column>
下一页：[[im:other:integrationcases:nickname|昵称和头像的显示与更新]]
</WRAP>
</WRAP>