OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse OpenIMSDK Guides
GUIDESOpenIMSDK Guides

OpenIMSDK guides organized by implementation stage, from product concepts and deployment to integration, extension, operations, and reliability.

Guides

Business System Integration

Connect account systems, backend services, APIs, and webhooks.

Copy

Integrate with an existing business system

Instant messaging (IM) has become an essential foundational capability for many applications. If you already have an existing business system and want to add chat capabilities using OpenIMSDK, follow this guide to connect your business accounts, business backend, OpenIMServer, and OpenIMClientSDK.

OpenIMSDK and business system relationship

In the diagram above:

  • Your APP Server represents your existing business backend in any development language. It continues to maintain business data such as user credentials and password authentication.
  • Your APP Client represents your existing business client application, built with any mainstream frontend framework.

Connect business backend to OpenIMServer via REST API

  1. Register new users: When a user registers in your business system, call the Create user endpoint to create the corresponding user in OpenIMServer.
  2. Update user profiles: When a user updates their avatar, nickname, or custom extension fields, call the Update user endpoint to sync the updated profile.
  3. Retrieve login tokens: After the business backend authenticates user credentials, call the Get user token endpoint and return the IM token to the client.
  4. Import existing users: Before going live, import existing user accounts into OpenIMServer by calling the create user endpoint.

Integrate OpenIMClientSDK into business client

  1. Log in: After obtaining the IM token from your business backend, call the OpenIMClientSDK login method.
  2. Enable instant messaging features: Integrate OpenIMClientSDK into your application and activate conversations, messages, groups, and friendship capabilities as needed.
  3. Maintain profile source of truth: Keep your business backend as the single source of truth for user profiles. When profiles change, synchronize them from your business backend to OpenIMServer.