跳到主要内容

license

向 ONLYOFFICE 文档请求许可证，并获取有关服务器和用户配额的信息。

请求示例​

{
  "c": "license"
}

参数​

名称类型出现描述
cstring必需的定义命令类型。

响应示例​

{
  "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"
      }
    ]
  }
}

响应示例​

参数类型出现描述
errorinteger必需的定义错误代码。
licenseobject可选的定义文档许可证信息：

end_date - 许可证到期日期，
type: 字符串，
presence: 必需；

trial - 定义许可证是否为试用版，
type: 布尔值，
presence: 必需；

customization - 定义带有自定义标记的参数是否仅在 ONLYOFFICE 开发者版本中可用，
type: 布尔值，
presence: 必需；

connections - 连接许可证的连接数，
type: 整数，
presence: 可选；

connections_view - 实时查看器的连接数，
type: 整数，
presence: 可选；

users_count - 用户许可证的用户数，
type: 整数，
presence: 可选；

users_view_count - 实时查看器的用户数，
type: 整数，
presence: 可选；

users_expire - 用户许可证到期的天数，
type: 整数，
presence: 可选。
serverobject必需的定义服务器特征：

resultType - 许可证状态（1 - 发生错误，2 - 许可证已过期，3 - 许可证仍然有效，6 - 试用许可证已过期），
type: 整数，
presence: 必需；

packageType - 产品版本（0 - 开源产品，1 - 企业版，2 - 开发者版），
type: 整数，
presence: 必需；

buildDate - 构建日期，
type: 字符串，
presence: 必需；

buildVersion - 构建版本，
type: 字符串，
presence: 可选；

buildNumber - 构建编号，
type: 整数，
presence: 必需。
quotaobject必需的定义用户配额值：

users - 用户许可证的用户配额，其中 userid - 打开编辑器的用户 ID，expire - 此用户的许可证到期日期，
type: 对象数组，
presence: 必需；

users_view - 实时查看器的用户配额，其中 userid - 打开编辑器的用户 ID，expire - 此用户的查看到期日期，
type: 对象数组，
presence: 必需。