Skip to content

Commit 85412db

Browse files
authored
Merge pull request #1382 from haoxiuwen/doc-v2
Remove -L from REST APIs & Prioritizing Authorized User Registration in SDK Login Docs
2 parents 6410dc4 + d8a3aad commit 85412db

26 files changed

+144
-210
lines changed
27.5 KB
Loading

docs/document/android/login.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
## 用户注册
66

7-
用户注册模式分为以下两种:
7+
1. 可通过以下两种方式调用接口创建用户:
8+
9+
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
810

911
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
1012

@@ -15,9 +17,9 @@
1517
EMClient.getInstance().createAccount(mAccount, mPassword);// 同步方法。
1618
```
1719

18-
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
20+
2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户:
1921

20-
除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
22+
可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
2123

2224
## 主动登录
2325

docs/document/applet/login.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,15 @@
44

55
## 用户注册
66

7-
用户注册支持以下方式:
7+
1. 可通过以下两种方式调用接口创建用户:
88

9-
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户
9+
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍
1010

11-
示例代码如下:
12-
13-
```javascript
14-
conn.registerUser({
15-
username: "user1",
16-
password: "xxx",
17-
});
18-
```
11+
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
1912

20-
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
13+
2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户:
2114

22-
除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
15+
可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
2316

2417
## 登录方式
2518

docs/document/flutter/login.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,15 @@
44

55
## 用户注册
66

7-
用户注册模式分为以下两种
7+
1. 可通过以下两种方式调用接口创建用户
88

9-
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
9+
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
1010

11-
示例代码如下所示:
12-
13-
```dart
14-
try {
15-
await EMClient.getInstance.createAccount(userId, password);
16-
} on EMError catch (e) {}
17-
```
11+
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
1812

19-
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
13+
2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户:
2014

21-
除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
15+
可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
2216

2317
## 主动登录
2418

docs/document/harmonyos/login.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,15 @@
44

55
## 用户注册
66

7-
用户注册模式分为以下两种:
7+
1. 可通过以下两种方式调用接口创建用户:
8+
9+
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
810

911
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
1012

11-
示例代码如下所示:
12-
13-
```typescript
14-
ChatClient.getInstance().createAccount(userId, pwd).then(()=> {
15-
// success logic
16-
});
17-
```
18-
19-
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
13+
2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户:
2014

21-
除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
15+
可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
2216

2317
## 主动登录
2418

docs/document/ios/login.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,15 @@
44

55
## 用户注册
66

7-
用户注册模式分为以下两种:
7+
1. 可通过以下两种方式调用接口创建用户:
8+
9+
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
810

911
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
1012

11-
示例代码如下所示:
12-
13-
```swift
14-
// 异步方法
15-
EMClient.shared.register(withUsername: "userId", password: "your password") { userId, e in
16-
17-
}
18-
```
19-
20-
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
13+
2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户:
2114

22-
除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
15+
可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 创建用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
2316

2417
## 主动登录
2518

docs/document/react-native/login.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,15 @@
44

55
## 用户注册
66

7-
用户注册模式分为以下两种
7+
1. 可通过以下两种方式调用接口创建用户
88

9-
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
10-
11-
示例代码如下所示:
12-
13-
```typescript
14-
ChatClient.getInstance()
15-
.createAccount(username, password)
16-
.then((value: any) => {
17-
console.log("createAccount: success", value);
18-
})
19-
.catch((reason: any) => {
20-
console.log("createAccount: fail", reason);
21-
});
22-
```
9+
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
2310

24-
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
11+
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
12+
13+
2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户:
2514

26-
除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
15+
可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
2716

2817
## 主动登录
2918

docs/document/server-side/account_system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1525,7 +1525,7 @@ GET https://{host}/{org_name}/{app_name}/users/{username}/resources
15251525

15261526
```shell
15271527
# 将 <YourAppToken> 替换为你在服务端生成的 App Token
1528-
curl -L -X GET 'http://XXXX/XXXX/XXXX/users/XXXX/resources' \
1528+
curl -X GET 'http://XXXX/XXXX/XXXX/users/XXXX/resources' \
15291529
-H 'Accept: application/json' \
15301530
-H 'Authorization: Bearer <YourAppToken>'
15311531
```

docs/document/server-side/chatroom_manage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ GET https://{host}/{org_name}/{app_name}/chatrooms?limit={N}&cursor={cursor}
123123
```shell
124124
# 将 <YourAppToken> 替换为你在服务端生成的 App Token
125125

126-
curl -L -X GET 'https://XXXX/XXXX/XXXX/chatrooms?limit=10' \
126+
curl -X GET 'https://XXXX/XXXX/XXXX/chatrooms?limit=10' \
127127
--header 'Authorization: Bearer <YourAppToken>'
128128
```
129129

docs/document/server-side/chatroom_superadmin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ DELETE https://{host}/{org_name}/{app_name}/chatrooms/super_admin/{superAdmin}
298298
```shell
299299
# 将 <YourAppToken> 替换为你在服务端生成的 App Token
300300

301-
curl -L -X DELETE 'https://XXXX/XXXX/XXXX/chatrooms/super_admin/XXXX'
301+
curl -X DELETE 'https://XXXX/XXXX/XXXX/chatrooms/super_admin/XXXX'
302302
--header 'Authorization: Bearer <YourAppToken>'
303303
```
304304

0 commit comments

Comments
 (0)