跳到主要内容

get_apply_license_file 查看许可申请文件内容

POST /api/v1/license/get_apply_license_file​

描述​

许可申请文件是填写了在线申请许可的必要信息的JSON文件，提前放在设备的指定位置。在工厂签发许可时，可以通过一键申请按钮，基于许可申请文件中的内容，与服务器进行通信，为当前设备申请许可文件。 本接口用于展示当前设备所使用的许可申请文件内容，避免因许可文件意外丢失或修改造成的问题。

访问权限​

需要登录，具备以下权限：

license:get_apply_license

JSON参数​

请求参数如下：

{}

无参数，必须传递空对象。

请求示例：

{}

响应结果​

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "data"?: {
    "serverIp": string,
    "serverPort": number,
    "apiToken": string,
    "metadataId": number,
    "batchNum": number,
    "fileExists": true|false
  },
  "errorCode"?: "option string",
  "errorMessage": "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
备注
  • fileExists: 该文件是否存在，不存在时返回false，提供的其他属性是预制内容
  • serverIp: 服务器IP
  • serverPort: 端口号
  • apiToken: 访问服务器接口的API TOKEN
  • metadataId: 许可模板ID
  • batchNum: 批次编号

正确结果示例：

{
  "success": true,
  "data": {
    "fileExists": false,
    "serverIp": "",
    "serverPort": -1,
    "apiToken": "",
    "metadataId": -1,
    "batchNum": -1
  }
}

错误结果示例, 返回false时候需要带上错误码和错误信息：

{
  "success": false,
  "errorCode": "40000",
  "errorMessage": "no.blank.params",
  "showType": 4
}

错误码​

提示

4 表示弹框提示错误信息。