license
从文档服务器请求许可证,以及有关服务器和用户配额的信息。
{
"c": "license"
}
名称 |
描述 |
类型 |
出现 |
c |
定义命令类型。 |
string |
必需的 |
{
"error": 0,
"license": {
"end_date": "2021-07-07T23:59:59.000Z",
"trial": false,
"customization": false,
"connections": 0,
"connections_view": 0,
"users_count": 10,
"users_view_count": 10,
"users_expire": 30
},
"server": {
"resultType": 3,
"packageType": 1,
"buildDate": "2021-05-21T00:00:00.000Z",
"buildVersion": "6.3.0",
"buildNumber": 111
},
"quota": {
"users": [
{
"userid": "uid-0",
"expire": "2021-07-07T23:59:59.000Z"
},
{
"userid": "uid-1",
"expire": "2021-07-09T23:59:59.000Z"
},
...
],
"users_view": [
{
"userid": "uid-0",
"expire": "2021-07-07T23:59:59.000Z"
},
{
"userid": "uid-1",
"expire": "2021-07-09T23:59:59.000Z"
},
...
]
}
}
参数 |
描述 |
类型 |
出现 |
error |
定义错误代码 |
integer |
必需的 |
license |
定义文档许可证信息:
-
End_date - 许可证到期日期。
type:字符串
存在:必需
-
trial - 定义许可证是否试用。
Type:布尔型:布尔型
存在:必需
-
customization - 定义标记为*符号的 customization 参数是否仅在ONLYOFFICE 开发者版本中可编辑。
Type:布尔型:布尔型
存在:必需
-
connections - 连接许可证的连接数。
type: integer
出现: 可选的
-
connections_view - 实时查看器的连接数。
type: integer
出现: 可选的
-
users_count - 用户许可证的用户数。
type: integer
出现: 可选的
-
users_view_count - 实时查看器的用户数。
type: integer
出现: 可选的
-
users_expire - 用户许可证过期的天数。
type: integer
出现: 可选的
|
对象 |
必需的 |
server |
定义服务器特征:
-
resultType - 许可证状态 (1 - 发生错误, 2 - 许可证过期, 3 - 许可证仍然可用, 6 - 试用许可证过期).
类型: integer
存在: 必需的
-
packageType - 产品版本 (0 - 开源产品, 1 - 企业版, 2 - 开发者版).
type: integer
出现: 必需的
-
buildDate - 生成日期.
type:字符串
存在:必需
-
buildVersion - 生成版本.
type:string
出现:可选的
-
buildNumber - 内部版本号
type: integer
出现: 必需的
|
对象 |
必需的 |
quota |
定义用户配额值:
-
users - 用户许可证的用户配额,其中 userid - 打开编辑器的用户的id, expire - 此用户的许可证过期日期。
type: object数组
出现: 必需的
-
users_view-实时查看器的用户配额,其中userid - 打开编辑器的用户的id,expire - 此用户的查看过期日期。
type: object数组
出现: 必需的
|
对象 |
必需的 |