接入准备
在调用 OpenIM Platform API 前，先确认基础地址、公共请求头、鉴权 Token 和请求体约定。本文按照 Platform API 的接入准备结构组织，参数和认证方式以 OpenIM REST 文档为准。
Note: 建议通过业务服务端调用 Platform API，并在服务端完成鉴权、审计和错误处理。不要将管理员 Token 或管理接口直接暴露给客户端。
基础地址
OpenIM REST 接口使用部署环境中的 API 地址作为基础地址。文档中的 {API_ADDRESS} 需要替换为你的 OpenIM API 网关或服务端地址。
{API_ADDRESS}例如，接口页中的 POST {API_ADDRESS}/user/get_users 表示向当前环境的 /user/get_users 端点发起请求。生产环境建议只允许可信后端访问管理端接口，不要把管理员 Token 暴露给客户端。
请求头
OpenIM 管理端 REST API 以 JSON 请求为主。除具体接口另有说明外，请求通常需要携带以下请求头。
| 请求头 | 必填 | 说明 |
|---|---|---|
| Content-Type | 是 | JSON 请求使用 application/json; charset=utf-8。 |
| operationID | 是 | 全局链路追踪 ID。建议每次请求生成独立值，便于串联服务端日志。 |
| token | 管理端接口必填 | APP 管理员 Token。创建用户等少数初始化接口可能不需要，具体以接口页为准。 |
鉴权
Platform API 应由服务端调用。这个服务端可以是客户自己的业务服务器，也可以是 OpenIM 提供的 Chat Server；它负责配置 OpenIM API 地址、管理员账号和管理员凭据 secret，并在服务端完成 Token 获取、缓存、刷新和审计。
管理端调用
服务端先调用获取管理员 Token，使用管理员账号和 secret 换取 APP 管理员 Token。后续创建用户、创建群组、发送服务端消息、导入关系或执行运营管理接口时，把管理员 Token 放在请求头 token 中调用对应 Platform API。
客户端登录
当业务用户注册、密码登录或完成第三方登录后，客户端不应直接接触管理员 Token。业务服务器或 OpenIM Chat Server 在确认业务身份后，调用获取用户 Token为该用户签发用户 Token，也就是客户端登录 OpenIM SDK 使用的 IM Token，并把它返回给客户端。
常见接入顺序如下：
- 在业务服务器或 OpenIM Chat Server 中配置 OpenIM API 地址、管理员账号和
secret。 - 服务端调用获取管理员 Token，换取 APP 管理员 Token。
- 服务端使用管理员 Token 调用用户、群组、消息、关系等管理端接口。
- 用户登录业务系统后，服务端调用获取用户 Token，签发 IM Token 并返回给客户端。
请求体
当前保留的 OpenIM Platform API 页面均为 POST 到固定路径，业务参数放在 JSON 请求体中。不要把分页、用户 ID、群组 ID 或消息字段拼接到 URL query。
如果字段值本身是 URL，例如头像地址、文件地址或对象存储地址，作为 JSON 字段提交时保留原始字符串即可。
这个页面有帮助吗？