使用前准备
- 在比特控制台获取自己的
比特BitKey
,获取路径:头像
->费用
->显示BitKey
。 - API的地址是以
https://back-office-api.bitanswer.cn/bitanswer/api
起始的,在每一个请求的headers
中要添加bitkey={bit_key}
。 - 请求体使用
JSON
格式入参,headers
中需要添加Content-Type=application/json
。 - 所有请求地址都需要使用Url编码后发送。
- 响应格式
{
"status": 0,
"msg": 0,
"data": {
"total": 0,
"items": []
}
}
文档说明
- 文档中以
{}
包含的内容表示变量,是需要开发商在使用时修改填充的内容(例:{bit_key}
,换成开发商自己的密钥)。 - 参数类型说明:
string
表示字符串;integer
表示数字;boolean
表示布尔类型,只能输入true
和false
;object
表示 一个对象类型,参数另行说明;array
表示要传入一个数组,数组中结构参数另行说明。 - 响应体只会返回非空节点,例如:一个SN没有设置有效期时,就不会返回相应字段。
名词解释
以下名称不区分大小写
- Product:产品,一组需要保护的功能项,该功能项可以是一个按钮、一段数据、一个API等。
- Template:模版,定义一组功能项的版本,指定版本中默认包含的功能、配置及数据。
- Business:业务,定义要发行的应用类型以及授权模式,包括传统桌面软件、移动应用或Web应用。
- SN:授权码。
- Feature:特征项。
- Data:配置项。
- Customer:客户,企业客户可以集中管理所购授权及内部用户。
- BitKey(bit_key):用于调用接口时认证的一个字符串。
- RequestCode:客户端生成的请求串,发送到服务端生成升级串。
- UpdateCode:服务端产生的升级串,输入到客户端完成激活/升级。
- DeviceCode:设备码,由客户端或集团服务生成,发送给服务端可产生升级码,是一段形如
00000000-00000000-00000000
的字符串。 - Log:日志。