From ec2285d82ea936df6222ca68327854e28721d984 Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Sat, 21 Sep 2024 14:25:39 +0800 Subject: [PATCH] docs: update secret contents path. --- .../authenticationManagement/getToken.mdx | 65 ++++++++++--------- .../apis/userManagement/userRegister.mdx | 60 +++++++++-------- 2 files changed, 65 insertions(+), 60 deletions(-) diff --git a/docs/restapi/apis/authenticationManagement/getToken.mdx b/docs/restapi/apis/authenticationManagement/getToken.mdx index f8c68644db..5fc028eca1 100644 --- a/docs/restapi/apis/authenticationManagement/getToken.mdx +++ b/docs/restapi/apis/authenticationManagement/getToken.mdx @@ -6,32 +6,32 @@ hide_title: true
-## 以secret获取token +## 以 secret 获取 token
### 简要描述 -- 获取用户或 APP 管理员token。 - -⚠️ **注意**: OpenIMServer 内置了一个APP 管理员，它的 `userID` 是`imAdmin`： +- 获取用户或 APP 管理员 token。 +⚠️ **注意**: OpenIMServer 内置了一个 APP 管理员，它的 `userID` 是`imAdmin`： ### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/auth/user_token` +- `post` + +### 请求 URL + +- `http://x.x.x.x:10002/auth/user_token` ### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +| header 名 | 示例值 | 选填 | 类型 | 说明 | +| :---------- | :------------ | :--- | ------ | ---------------------------- | +| operationID | 1646445464564 | 必填 | string | operationID 用于全局链路追踪 | ### 请求参数示例 - ```json { "secret": "openIM123", @@ -39,13 +39,14 @@ hide_title: true "userID": "111111" } ``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|secret|必填|string|openIM 密钥，见config/config.yaml中secret字段| -|platformID|必填|int|平台ID, 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin| -|userID|必填|string|用户ID或管理员ID， 如生成管理员token， 需填写 `imAdmin` | -### 成功返回示例 +| 字段名 | 选填 | 类型 | 说明 | +| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- | +| secret | 必填 | string | openIM 密钥，见 config/share.yaml 中 secret 字段 | +| platformID | 必填 | int | 平台 ID, 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin | +| userID | 必填 | string | 用户 ID 或管理员 ID， 如生成管理员 token， 需填写 `imAdmin` | + +### 成功返回示例 ```json { @@ -58,20 +59,20 @@ hide_title: true } } ``` + ### 成功返回示例的参数说明 +| 参数名 | 类型 | 说明 | +| :---------------- | :----- | :--------------------------- | +| errCode | int | 错误码,0 表示成功 | +| errMsg | string | 错误简要信息,无错误时为空 | +| errDlt | errDlt | 错误详细信息,无错误时为空 | +| data | object | 通用数据对象，具体结构见下方 | +| token | string | 获取到的用户 token | +| expireTimeSeconds | string | token 的过期时间（单位秒） | -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|token|string|获取到的用户token| -|expireTimeSeconds|string|token的过期时间（单位秒）| ### 失败返回示例 - ```json { "errCode": 1004, @@ -79,11 +80,11 @@ hide_title: true "errDlt": ": [1004]RecordNotFoundError" } ``` -### 失败返回示例的参数说明 +### 失败返回示例的参数说明 -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| +| 参数名 | 类型 | 说明 | +| :------ | :----- | :---------------------------- | +| errCode | int | 错误码,具体查看全局错误码文档 | +| errMsg | string | 错误简要信息 | +| errDlt | errDlt | 错误详细信息 | diff --git a/docs/restapi/apis/userManagement/userRegister.mdx b/docs/restapi/apis/userManagement/userRegister.mdx index 75fefdbbaf..e94eba7c13 100644 --- a/docs/restapi/apis/userManagement/userRegister.mdx +++ b/docs/restapi/apis/userManagement/userRegister.mdx @@ -11,22 +11,25 @@ hide_title: true ### 简要描述 -- 用户通过AppServer完成账号注册后，AppServer再调用此接口导入IM以实现账号打通。 + +- 用户通过 AppServer 完成账号注册后，AppServer 再调用此接口导入 IM 以实现账号打通。 + ### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/user/user_register` +- `post` + +### 请求 URL + +- `http://x.x.x.x:10002/user/user_register` ### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +| header 名 | 示例值 | 选填 | 类型 | 说明 | +| :---------- | :------------ | :--- | ------ | ---------------------------- | +| operationID | 1646445464564 | 必填 | string | operationID 用于全局链路追踪 | ### 请求参数示例 - ```json { "secret": "openIM123", @@ -39,15 +42,16 @@ hide_title: true ] } ``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|secret|必填|string|openIM 密钥，见config/config.yaml中secret字段| -|users|必填|array|用户列表| -|users.userID|必填|string|用户ID| -|users.nickname|必填|string|用户昵称| -|users.faceURL|必填|string|用户头像链接| -### 成功返回示例 +| 字段名 | 选填 | 类型 | 说明 | +| :------------- | :--- | :----- | ------------------------------------------------ | +| secret | 必填 | string | openIM 密钥，见 config/share.yaml 中 secret 字段 | +| users | 必填 | array | 用户列表 | +| users.userID | 必填 | string | 用户 ID | +| users.nickname | 必填 | string | 用户昵称 | +| users.faceURL | 必填 | string | 用户头像链接 | + +### 成功返回示例 ```json { @@ -56,17 +60,17 @@ hide_title: true "errDlt": "" } ``` + ### 成功返回示例的参数说明 +| 参数名 | 类型 | 说明 | +| :------ | :----- | :------------------------ | +| errCode | int | 错误码，0 表示成功 | +| errMsg | string | 错误简要信息,无错误时为空 | +| errDlt | errDlt | 错误详细信息,无错误时为空 | -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码，0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| ### 失败返回示例 - ```json { "errCode": 1004, @@ -74,11 +78,11 @@ hide_title: true "errDlt": ": [1004]RecordNotFoundError" } ``` -### 失败返回示例的参数说明 +### 失败返回示例的参数说明 -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| +| 参数名 | 类型 | 说明 | +| :------ | :----- | :---------------------------- | +| errCode | int | 错误码,具体查看全局错误码文档 | +| errMsg | string | 错误简要信息 | +| errDlt | errDlt | 错误详细信息 |