RESTful接口可以对集团服务进行相关操作，如查询产品信息、查询SN信息、激活授权码等。

调用说明

  1. 请求头参数格式
  • application/json：返回JSON格式数据
  • 其它：返回XML格式数据

安全验证

调用RESTful接口时必须使用安全口令进行访问。

认证方式有两种：

  • 将口令写在URL里。示例：ip:port/rest/<pwd>/product，其中<pwd>就是口令。

  • 将口令写在HTTP请求头里。示例：Authorization:<pwd>

    HTTP请求头的优先级高于URL参数。

注意：

  1. 14.5.0版本及以上的集团服务针对只读的RESTful接口将不在校验口令。

  2. API v2仅支持将口令写在HTTP请求头里的方式。

口令的生成方式有两种：

  1. 通过修改bit_service.xml文件

打开集团服务安装目录下的 bit_service.xml 文件，添加 RESTful 访问密码，此密码会在 URL 中用到，将红色字体的代码拷贝到 bit_service.xml 文件中，然后重启集团服务。

<?xml version="1.0" encoding="UTF-8"?>
<BitAnswerSrvConfig>
  <Users/>
  <RestFul>
    <License did="0" pid="0">bitanswer</License>
  </RestFul>
</BitAnswerSrvConfig>
  1. 通过命令行设置安全口令

命令：-r [-d <productId>] [-p <path>] [-s <show>] [-c <clear>] [-a <pwd>]

参数说明：

  • 随机生成一串口令：bit_service -r
  • 将生成的口令保存到文件：bit_service -r -p /xxx/
  • 显示已有口令：bit_service -r -s
  • 清空已有口令：bit_service -r -c
  • 添加自定义口令：bit_service -r -a xxxx

示例：

./bit_service -r -a bitanswer

API版本选择建议

RESTful API同时提供v1、v2两个版本并行服务，v2版本接口完全兼容v1版本且涵盖v1版本的所有功能；用户升级至v2后无需大规模功能适配改造，即可直接正常运行。

版本支持范围：

  • API v1：全版本兼容
  • API v2：14.5.0及以上版本新支持

v2版本以v1版本为基础，做了如下增强：

  • 参数规范化升级：针对过往接口存在的参数命名不统一、含义易混淆等问题，v2版本对所有接口的对所有接口的参数名及对应含义进行全面梳理与标准化规范，降低开发者理解成本和使用难度，提升接口调用的准确性与效率。
  • 安全验证方式调整：调用RESTful接口时必须使用安全口令进行访问，与v1版本不同，API v2版本仅支持“将安全口令写在HTTP请求头里”的认证方式，取消了v1版本中“将口令写在URL里”的认证方式，该调整提升了密码传输的安全性，避免密码在URL中暴露导致的安全风险。

注意事项

需要先在集团授权管理中心中开启详细日志（参见用量数据），用户使用信息和出错信息才会保存到日志中。