Skip to content

Commit ec2285d

Browse files
mo3etmo3et
committed
docs: update secret contents path.
1 parent a92633b commit ec2285d

File tree

2 files changed

+65
-60
lines changed

2 files changed

+65
-60
lines changed

‎docs/restapi/apis/authenticationManagement/getToken.mdx‎

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,47 @@ hide_title: true
66

77
<center>
88

9-
## 以secret获取token
9+
## 以 secret 获取 token
1010

1111
</center>
1212

1313
### 简要描述
14-
- 获取用户或 APP 管理员token。
15-
16-
⚠️ **注意**: OpenIMServer 内置了一个APP 管理员，它的 `userID` 是`imAdmin`：
1714

15+
- 获取用户或 APP 管理员 token。
1816

17+
⚠️ **注意**: OpenIMServer 内置了一个 APP 管理员，它的 `userID` 是`imAdmin`：
1918

2019
### 请求方式
21-
- `post`
22-
### 请求URL
23-
- `http://x.x.x.x:10002/auth/user_token`
2420

21+
- `post`
22+
23+
### 请求 URL
24+
25+
- `http://x.x.x.x:10002/auth/user_token`
2526

2627
### Header
27-
|header名|示例值|选填|类型|说明|
28-
|:---- |:------- |:--- |---|------ |
29-
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
3028

29+
| header 名 | 示例值 | 选填 | 类型 | 说明 |
30+
| :---------- | :------------ | :--- | ------ | ---------------------------- |
31+
| operationID | 1646445464564 | 必填 | string | operationID 用于全局链路追踪 |
3132

3233
### 请求参数示例
3334

34-
3535
```json
3636
{
3737
"secret": "openIM123",
3838
"platformID": 1,
3939
"userID": "111111"
4040
}
4141
```
42-
|字段名|选填|类型|说明|
43-
|:---- |:------- |:--- |---|
44-
|secret|必填|string|openIM 密钥，见config/config.yaml中secret字段|
45-
|platformID|必填|int|平台ID, 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin|
46-
|userID|必填|string|用户ID或管理员ID， 如生成管理员token， 需填写 `imAdmin` |
47-
### 成功返回示例
4842

43+
| 字段名 | 选填 | 类型 | 说明 |
44+
| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- |
45+
| secret | 必填 | string | openIM 密钥，见 config/share.yaml 中 secret 字段 |
46+
| platformID | 必填 | int | 平台 ID, 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin |
47+
| userID | 必填 | string | 用户 ID 或管理员 ID， 如生成管理员 token， 需填写 `imAdmin` |
48+
49+
### 成功返回示例
4950

5051
```json
5152
{
@@ -58,32 +59,32 @@ hide_title: true
5859
}
5960
}
6061
```
62+
6163
### 成功返回示例的参数说明
6264

65+
| 参数名 | 类型 | 说明 |
66+
| :---------------- | :----- | :--------------------------- |
67+
| errCode | int | 错误码,0 表示成功 |
68+
| errMsg | string | 错误简要信息,无错误时为空 |
69+
| errDlt | errDlt | 错误详细信息,无错误时为空 |
70+
| data | object | 通用数据对象，具体结构见下方 |
71+
| token | string | 获取到的用户 token |
72+
| expireTimeSeconds | string | token 的过期时间（单位秒） |
6373

64-
|参数名|类型|说明|
65-
|:---- |:------- |:--- |
66-
|errCode|int|错误码,0表示成功|
67-
|errMsg|string|错误简要信息,无错误时为空|
68-
|errDlt|errDlt|错误详细信息,无错误时为空|
69-
|data|object|通用数据对象，具体结构见下方|
70-
|token|string|获取到的用户token|
71-
|expireTimeSeconds|string|token的过期时间（单位秒）|
7274
### 失败返回示例
7375

74-
7576
```json
7677
{
7778
"errCode": 1004,
7879
"errMsg": "RecordNotFoundError",
7980
"errDlt": ": [1004]RecordNotFoundError"
8081
}
8182
```
82-
### 失败返回示例的参数说明
8383

84+
### 失败返回示例的参数说明
8485

85-
|参数名|类型|说明|
86-
|:---- |:------- |:--- |
87-
|errCode|int|错误码,具体查看全局错误码文档|
88-
|errMsg|string|错误简要信息|
89-
|errDlt|errDlt|错误详细信息|
86+
| 参数名 | 类型 | 说明 |
87+
| :------ | :----- | :---------------------------- |
88+
| errCode | int | 错误码,具体查看全局错误码文档 |
89+
| errMsg | string | 错误简要信息 |
90+
| errDlt | errDlt | 错误详细信息 |

‎docs/restapi/apis/userManagement/userRegister.mdx‎

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,25 @@ hide_title: true
1111
</center>
1212

1313
### 简要描述
14-
- 用户通过AppServer完成账号注册后，AppServer再调用此接口导入IM以实现账号打通。
14+
15+
- 用户通过 AppServer 完成账号注册后，AppServer 再调用此接口导入 IM 以实现账号打通。
16+
1517
### 请求方式
16-
- `post`
17-
### 请求URL
18-
- `http://x.x.x.x:10002/user/user_register`
1918

19+
- `post`
20+
21+
### 请求 URL
22+
23+
- `http://x.x.x.x:10002/user/user_register`
2024

2125
### Header
22-
|header名|示例值|选填|类型|说明|
23-
|:---- |:------- |:--- |---|------ |
24-
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
2526

27+
| header 名 | 示例值 | 选填 | 类型 | 说明 |
28+
| :---------- | :------------ | :--- | ------ | ---------------------------- |
29+
| operationID | 1646445464564 | 必填 | string | operationID 用于全局链路追踪 |
2630

2731
### 请求参数示例
2832

29-
3033
```json
3134
{
3235
"secret": "openIM123",
@@ -39,15 +42,16 @@ hide_title: true
3942
]
4043
}
4144
```
42-
|字段名|选填|类型|说明|
43-
|:---- |:------- |:--- |---|
44-
|secret|必填|string|openIM 密钥，见config/config.yaml中secret字段|
45-
|users|必填|array|用户列表|
46-
|users.userID|必填|string|用户ID|
47-
|users.nickname|必填|string|用户昵称|
48-
|users.faceURL|必填|string|用户头像链接|
49-
### 成功返回示例
5045

46+
| 字段名 | 选填 | 类型 | 说明 |
47+
| :------------- | :--- | :----- | ------------------------------------------------ |
48+
| secret | 必填 | string | openIM 密钥，见 config/share.yaml 中 secret 字段 |
49+
| users | 必填 | array | 用户列表 |
50+
| users.userID | 必填 | string | 用户 ID |
51+
| users.nickname | 必填 | string | 用户昵称 |
52+
| users.faceURL | 必填 | string | 用户头像链接 |
53+
54+
### 成功返回示例
5155

5256
```json
5357
{
@@ -56,29 +60,29 @@ hide_title: true
5660
"errDlt": ""
5761
}
5862
```
63+
5964
### 成功返回示例的参数说明
6065

66+
| 参数名 | 类型 | 说明 |
67+
| :------ | :----- | :------------------------ |
68+
| errCode | int | 错误码，0 表示成功 |
69+
| errMsg | string | 错误简要信息,无错误时为空 |
70+
| errDlt | errDlt | 错误详细信息,无错误时为空 |
6171

62-
|参数名|类型|说明|
63-
|:---- |:------- |:--- |
64-
|errCode|int|错误码，0表示成功|
65-
|errMsg|string|错误简要信息,无错误时为空|
66-
|errDlt|errDlt|错误详细信息,无错误时为空|
6772
### 失败返回示例
6873

69-
7074
```json
7175
{
7276
"errCode": 1004,
7377
"errMsg": "RecordNotFoundError",
7478
"errDlt": ": [1004]RecordNotFoundError"
7579
}
7680
```
77-
### 失败返回示例的参数说明
7881

82+
### 失败返回示例的参数说明
7983

80-
|参数名|类型|说明|
81-
|:---- |:------- |:--- |
82-
|errCode|int|错误码,具体查看全局错误码文档|
83-
|errMsg|string|错误简要信息|
84-
|errDlt|errDlt|错误详细信息|
84+
| 参数名 | 类型 | 说明 |
85+
| :------ | :----- | :---------------------------- |
86+
| errCode | int | 错误码,具体查看全局错误码文档 |
87+
| errMsg | string | 错误简要信息 |
88+
| errDlt | errDlt | 错误详细信息 |

0 commit comments

Comments
 (0)