上云无忧 > 文档中心 > 环信IM即时通讯(服务端) - 使用环信 App Token 鉴权
IM即时通讯
环信IM即时通讯(服务端) - 使用环信 App Token 鉴权

文档简介:
环信提供的 REST API 需要 app token (管理员权限 token) 才能使用,即发送 HTTP 请求时需要携带 app token。本文介绍如何获取 app token。 另外,环信 Server SDK 提供了用户、消息、群组、聊天室等资源的操作管理能力,详见 Java Server SDK 和 PHP Server SDK。
*此产品及展示信息均由环信官方提供。免费试用 咨询热线:400-826-7010,为您提供专业的售前咨询,让您快速了解云产品,助您轻松上云! 微信咨询
  免费试用、价格特惠


环信提供的 REST API 需要 app token (管理员权限 token) 才能使用,即发送 HTTP 请求时需要携带 app token。本文介绍如何获取 app token。

另外,环信 Server SDK 提供了用户、消息、群组、聊天室等资源的操作管理能力,详见 Java Server SDK 和 PHP Server SDK。

#获取管理员权限 Token

获取 token 时,服务器会返回 token 有效期,即响应中的 expires_in 字段的值。由于网络延迟等原因,系统不保证 token 在此值表示的有效期内绝对有效。如果发现 token 使用异常,如返回 HTTP 状态码 401,请重新获取新的 token。

提示

请不要频繁向服务器发送获取 token 的请求,同一账号发送此请求超过一定频率会被服务器封禁。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/token

#路径参数

参数 类型 是否必需 描述
host String 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 获取环信即时通讯 IM 的信息。
org_name String 环信即时通讯 IM 为每个公司(组织)分配的唯一标识。详见 获取环信即时通讯 IM 的信息。
app_name String 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 获取环信即时通讯 IM 的信息。

#请求 header

参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json。
Accept String 内容类型。请填 application/json。

#请求 body

参数 类型 是否必需 描述
grant_type String 授权方式。该参数设置为固定字符串 client_credentials,即客户端凭证模式。
client_id String App 的 client_id,用于生成 app token 调用 REST API。详见 环信即时通讯云控制台open in new window的应用详情页面。
client_secret String App 的 client_secret,用于生成 app token 调用 REST API。详见 环信即时通讯云控制台open in new window的应用详情页面。
ttl Long token 有效期,单位为秒(s)。设置为 0 则 token 有效期为永久。若不传该参数,默认值为 60 天,也可通过环信即时通讯云控制台open in new window的用户认证页面设置。该参数值以最新设置为准。

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200,表示成功返回 token。响应 body 包含如下字段:

参数 类型 描述
access_token String 有效的 Token 字符串。
expires_in Long Token 有效时间,单位为秒,在有效期内不需要重复获取。
application String 当前 App 的 UUID 值。

如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 响应状态码 了解可能的原因。

#示例

#请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
   "grant_type": "client_credentials",
   "client_id": "YXA6i-Ak8Ol4Eei2l11ZjV-EAg",
   "client_secret": "YXA6VunqiNxoB7IwXHInk1cGiXOOJfc",
   "ttl": "1024000"
 }' 'http://a1.easemob.com/easemob-demo/testapp/token' 

#响应示例

{ "access_token": "YWMte3bGuOukEeiTkNP4grL7iwAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QC
AgMAAAFnKdc-ZgBPGgBFTrLhhyK8woMEI005emtrLJFJV6aoxsZSioSIZkr5kw", "expires_in": 1024000, 
"application": "8be024f0-e978-11e8-b697-5d598d5f8402" }




相似文档
  • 客户端 SDK 不提供获取 token 的 API。如果你的用户在客户端使用环信 token 登录和鉴权,你需要在应用服务器(App Server)集成环信服务端获取 token 的 API,实现获取 Token 的业务逻辑。
  • 本文简要介绍环信即时通讯 IM 的使用限制条件,包括调用频率、字符串大小和编码格式等。 用户注册: 用户 ID:长度不能超过 64 字节,支持以下字符集: 26 个小写英文字母 a-z; 26 个大写英文字母 A-Z; 10 个数字 0-9; “_”, “-”, “.”。
  • 除部分 API 接口有特殊说明外,API 调用频率限制默认为 100 次/秒,具体每个接口限制以下表为准。 按模块查看接口调用频率限制: 用户帐号管理: 注册单个用户 POST /{org_name}/{app_name}/users; 批量注册用户 POST /{org_name}/{app_name}/users; 设置推送消息显示昵称 PUT /{org_name}/{app_name}/users/{username};
  • 环信即时通讯通过 REST 平台提供 REST API,你可以通过你的业务服务器向环信 REST 服务器发送 HTTP 请求,在服务端实现实时通信。 另外环信 Server SDK 提供了用户、消息、群组、聊天室等资源的操作管理能力,具体参见:Java Server SDK 和 PHP Server SDK。
  • 本文展示如何调用环信即时通讯 RESTful API 实现用户体系建立和管理,包括用户注册、获取、修改、删除、封禁、解禁、强制下线等。 公共参数: 以下表格列举了环信 IM 的 RESTful 接口的公共请求参数和响应参数: 请求参数: host,String,环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 获取环信即时通讯 IM 的信息。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部