通用接口

产品

接口名称 URL 接口概述
遍历产品 GET /products 遍历产品数据
查询产品 POST /products/data 根据指定条件查询产品
添加产品 POST /products 根据产品名称查询产品：若不存在则添加产品并生成名为Default的默认模版；若存在则跳过
按产品名更新产品 PATCH /products/{productName}
POST /products/{productName}		 通过地址参数上的产品名查询指定产品，修改产品的信息
按产品名删除产品 DELETE /products/{productName} 删除指定名称的产品
获取模块下载地址 GET /products/ref/{refId}/download_uri 根据产品的引用id查询指定的产品，获取指定产品的指定模块的下载地址。用户集成比特平台模块下载功能时使用

产品特征项

接口名称 URL 接口概述
遍历特征项 GET /products/{productName}/features 遍历指定产品的特征项
查询特征项 POST /products/{productName}/features/data
POST /products/ref/{refId}/features/data		 根据产品名或产品的引用id获取指定的产品，根据限定的条件查询、排序符合的产品特征项
批量更新/添加特征项 PATCH /products/{productName}/features
POST /products/{productName}/features
PATCH /products/ref/{refId}/features
POST /products/ref/{refId}/features		 根据产品名或产品的引用id获取指定的产品，更新/添加产品特征项的内容
批量删除特征项 DELETE /products/{productName}/features
DELETE /products/ref/{refId}/features		 根据产品名或产品的引用id获取指定的产品，批量删除指定的产品特征项。目前仅支持通过特征项的ID进行删除

产品模版

接口名称 URL 接口概述
遍历产品模版 GET /products/{productName}/templates 遍历指定产品的模版数据

模版

接口名称 URL 接口概述
遍历模版 GET /templates 遍历模版数据
查询模版 POST /templates/data 根据指定条件查询模版

业务

接口名称 URL 接口概述
遍历业务 GET /businesses 遍历业务数据
查询业务 POST /businesses/data 根据指定条件查询业务

授权码

接口名称 URL 接口概述
生成授权码 POST /sns/generate_sn 指定产品、模版、业务和数量后生成指定类型、指定数量的授权码
查询指定授权码 GET /sns/{sn} 查询指定授权码的信息
更新指定授权码 PATCH /sns/{sn} 更新指定授权码信息，仅更新输入的内容
删除指定授权码 DELETE /sns/{sn} 删除指定授权码信息
遍历授权码 GET /sns 遍历查询所有授权码
查询授权码 POST /sns/data 根据限定的条件查询、排序符合的授权码
批量更新授权码 PATCH /sns
POST /sns		 根据输入内容查找并更新授权码信息，目前仅支持通过sn查找
批量删除授权码 DELETE /sns 批量删除授权码
批量归档授权码 POST /sns/archive 批量归档授权码
批量取消归档授权码 POST /sns/unarchive 批量取消归档授权码

离线升级、借出、迁出

接口名称 URL 接口概述
通用离线升级 POST /sns/update_code 使用升级请求串获取升级串
离线升级（指定） POST /sns/{sn}/update_code 指定授权码离线升级
离线借出 POST /sns/checkout 使用借出请求串获取借出升级串
离线归还 POST /sns/checkin 使用归还请求串去提前归还借出的授权
批量离线升级 POST /sns/update_codes 批量使用升级请求串获取升级串
批量离线迁出 POST /sns/update_codes 批量使用浮动授权码的迁出请求串进行离线迁出
生成升级码 POST /sns/generate_update_code 生成SN并产生设备（或mac）的升级串
生成Bit-ID升级码 POST /sns/bitid_update_code 查询Bit-ID关联的授权码：未绑定则根据请求参数中的产品、模版、业务生成比特ID浮动授权类型的授权码，使用请求体中传入的endSn修改授权码的属性，将授权码绑定浮动的Bit-ID，产生升级串；已绑定授权码则直接产生升级串

授权码特征项

接口名称 URL 接口概述
遍历特征项 GET /sns/{sn}/features 遍历指定授权码的特征项
查询特征项 POST /sns/{sn}/features/data 指定授权码，根据限定的条件查询、排序符合的特征项
批量绑定/更新特征项 PATCH /sns/{sn}/features
POST /sns/{sn}/features		 根据输入内容，为授权码勾选特征项，并更新授权码特征项信息，目前仅支持通过ID查找。
批量删除特征项 DELETE /sns/{sn}/features 根据输入内容删除授权码的特征项，目前仅支持通过ID删除。
按名称获取特征项 GET /sns/{sn}/features/name/{featureName} 获取指定sn、指定名称的特征项
按名称删除特征项 DELETE /sns/{sn}/features/name/{featureName} 指定名称，移除SN所有的关联特征项
按ID获取特征项 GET /sns/{sn}/features/{uid} 获取指定SN、指定ID的特征项
按ID绑定/更新特征项 PATCH /sns/{sn}/features/{uid}
POST /sns/{sn}/features/{uid}		 指定特征项ID，为SN绑定特征项或更新特征项信息
按ID取消勾选指定特征项 DELETE /sns/{sn}/features/{uid} 指定特征项ID，为SN取消勾选特征项
按名称和版本获取特征项 GET /sns/{sn}/features/name/{featureName}/version/{version} 获取指定SN、指定名称和版本的唯一特征项
按名称和版本取消勾选指定特征项 DELETE /sns/{sn}/features/name/{featureName}/version/{version} 指定SN、指定名称和版本，接触特征项的勾选
按fid获取特征项 GET /sns/{sn}/features/fid/{fid} 获取指定授权码的指定fid的特征项列表
按fid取消勾选指定特征项 DELETE /sns/{sn}/features/fid/{fid} 按fid取消勾选授权码的特征项列表

授权码配置项

接口名称 URL 接口概述
遍历配置项 GET /sns/{sn}/datas 遍历指定授权码的配置项
查询配置项 POST /sns/{sn}/datas/data 根据限定的条件查询指定授权码的配置项，并按条件排序
批量更新/添加配置项 PATCH /sns/{sn}/datas
POST /sns/{sn}/datas		 按配置项名称查询指定授权码的配置项：若存在则修改；若不存在则添加
批量删除配置项 DELETE /sns/{sn}/datas 批量删除授权码的配置项
按名称获取配置项 GET /sns/{sn}/datas/{name} 按配置项名称查询指定授权码关联的配置项
按名称更新/添加配置项 PATCH /sns/{sn}/datas/{name}
POST /sns/{sn}/datas/{name}		 按配置项名称查询指定授权码的配置项：若存在则修改；若不存在则添加
按名称删除配置项 DELETE /sns/{sn}/datas/{name} 按配置项名称删除指定授权码的配置项

授权码设备

接口名称 URL 接口概述
遍历授权码下的设备 GET /sns/{sn}/machines 查询指定授权码绑定的设备
删除授权码绑定的设备 DELETE /sns/{sn}/machines 根据设备id删除指定授权码下的设备

用户

接口名称 URL 接口概述
遍历用户 GET /users 遍历用户数据
查询用户 POST /users/data 根据指定条件查询用户
批量更新/添加用户 PATCH /users
POST /users		 使用帐号查找指定的用户，进行批量更新/添加用户
批量删除用户 DELETE /users 批量删除用户
按帐号查询用户 GET /users/user/{name} 根据帐号查询指定用户
按帐号更新/添加用户 PATCH /users/user/{name}
POST /users/user/{name}		 使用帐号查找指定的用户，进行更新/添加用户
按帐号删除用户 DELETE /users/user/{name} 根据帐号删除指定用户
查询用户在线状态 GET /users/status 根据指定用户信息与在线状态
下线用户 POST /users/end 批量强制下线在线的用户

授权码用户

接口名称 URL 接口概述
遍历用户 GET /sns/{sn}/users 遍历指定授权码关联的用户
查询用户 POST /sns/{sn}/users/data 根据指定条件查询指定授权码关联的用户
批量关联用户 POST /sns/{sn}/users 查询指定授权码，根据帐号查询指定的用户进行绑定
批量解绑用户 DELETE /sns/{sn}/users 查询指定授权码，批量解绑用户
授权码绑定指定用户 POST /sns/{sn}/users/user/{name} 为指定授权码绑定指定的用户
授权码解绑指定用户 DELETE /sns/{sn}/users/{name} 为指定授权码解绑指定的用户

用户授权码

接口名称 URL 接口概述
查询用户授权码 POST /users/sn 根据指定条件查询指定用户关联的授权码

用户业务

接口名称 URL 接口概述
遍历用户关联的业务 GET /users/user/{guid}/businesses 遍历指定用户可访问或不可访问的业务列表
为用户关联业务 POST /users/user/{guid}/businesses 为指定用户关联帐号授权业务，并修改用户可访问的帐号授权业务的终端数和结束日期，若都不传则不修改，若终端数和结束日期只存在一个，则不传的将置为空

用户特征项

接口名称 URL 接口概述
遍历用户的特征项 GET /users/user/{guid}/features 遍历指定用户的特征项
为用户关联特征项 POST /users/user/{guid}/features 给用户关联指定产品的指定模版下的指定名称的特征项，一次仅允许关联一个模版的特征项。已关联的不会重复关联，不属于本产品的特征项不会关联，返回用户在这个产品模版下关联的特征项名称列表
取消用户关联的特征项 DELETE /users/user/{guid}/features 给用户取消关联指定产品的指定模版下的指定名称的特征项，一次仅允许取消关联一个模版的特征项。未关联的进行忽略，返回用户在这个产品模版下关联的特征项名称列表

用户角色

接口名称 URL 接口概述
遍历用户关联的角色 GET /users/user/{guid}/roles 遍历指定用户关联的角色

授权码用户设备

接口名称 URL 接口概述
遍历用户在线设备 GET /sns/{sn}/users/{name}/machines 遍历指定授权码的指定用户在线的设备列表
批量删除用户在线设备 DELETE /sns/{sn}/users/{name}/machines 批量删除指定授权码的指定用户在线的指定设
查询用户指定的在线设备 GET /sns/{sn}/users/{name}/machines/{id} 查询指定授权码的指定用户的指定在线设备信息
删除用户指定的在线设备 DELETE /sns/{sn}/users/{name}/machines/{id} 删除指定授权码的指定用户的指定在线设

授权码用户会话

接口名称 URL 接口概述
遍历用户会话 GET /sns/{sn}/users/{name}/sessions 遍历指定授权码的指定用户在线的会话列表
批量删除用户会话 DELETE /sns/{sn}/users/{name}/session 批量删除指定授权码的指定用户在线的指定设备
查询用户指定会话 GET /sns/{sn}/users/{name}/sessions/{id} 查询指定授权码的指定用户的指定会话信息
删除用户指定会话 DELETE /sns/{sn}/users/{name}/sessions/{id} 删除指定授权码的指定用户的指定会话

客户

接口名称 URL 接口概述
遍历客户 GET /customers 遍历客户数据
查询客户 POST /customers/data 根据限定的条件查询、排序符合的客户
批量更新/添加客户 PATCH /customers
POST /customers		 根据客户名查找指定的客户，支持PATCH或POST方法进行更新
批量删除客户 DELETE /api/customers 批量删除客户
按客户名查询客户 GET /customers/customer/{name} 根据客户名称查询指定客户
按客户名更新/添加客户 PATCH /customers/customer/{name}
POST /customers/customer/{name}		 根据客户名查找指定的客户，支持PATCH或POST方法进行更新
按客户名删除客户 DELETE /customers/customer/{name} 根据客户名删除指定客户

授权码客户

接口名称 URL 接口概述
查询授权码绑定的客户 GET /sns/{sn}/customers 查询指定授权码绑定的客户
授权码绑定客户 POST /sns/{sn}/customers 更新授权码绑定的客户。客户若不存在则新建客户并与授权码进行绑定
授权码绑定指定客户 POST /sns/{sn}/customers/name/{name}
POST /sns/{sn}/customers/name/{group_name}/{name}		 给指定授权码绑定（指定客户组下的）指定的客户
授权码解绑指定客户 DELETE /sns/{sn}/customers/name/{name}
DELETE /sns/{sn}/customers/name/{group_name}/{name}		 解除指定授权码绑定的（指定客户组下的）指定客户名称的客户

客户授权码

接口名称 URL 接口概述
查询客户绑定的授权码 GET /customers/{name}/sns，GET /customers/{group_name}/{name}/sns 查询（指定客户组下的）指定客户所绑定的授权码
客户批量绑定授权码 POST /customers/{name}/sns，POST /customers/{group_name}/{name}/sns 为（指定客户组下的）指定客户批量绑定授权码

授权码日志

接口名称 URL 接口概述
遍历授权码日志 GET /sns/{sn}/logs 遍历授权码的日志数据。只有云授权、帐号授权会记录
查询授权码日志 POST /sns/{sn}/logs/data 根据指定条件查询授权码的日志。只有云授权、帐号授权会记录

日志

接口名称 URL 接口概述
查询日志 POST /logs/data 根据指定条件查询日志。只有云授权、帐号授权会记录

Bit-ID

接口名称 URL 接口概述
遍历Bit-ID GET /bitids 遍历Bit-ID数据
查询Bit-ID POST /bitids/data 根据指定条件查询Bit-ID
按Bit-ID获取比特ID GET /bitids/guid/{guid}/{tokenType} 按Bit-ID查询指定的比特ID
按喷码获取比特ID GET /bitids/label/{label} 按喷码查询指定的比特ID

授权码Bit-ID

接口名称 URL 接口概述
遍历授权码的Bit-ID GET /sns/{sn}/bitids 遍历指定授权码绑定的Bit-ID数据
查询授权码的Bit-ID POST /sns/{sn}/bitids/data 根据指定条件查询指定授权码绑定的Bit-ID
批量操作Bit-ID POST /sns/{sn}/bitids Bit-ID四种批量操作
批量解绑Bit-ID DELETE /sns/{sn}/bitids 查询具体的Bit-ID与指定授权码进行解绑
按Bit-ID为授权码绑定比特ID POST /sns/{sn}/bitids/guid/{guid} 根据Bit-ID查询指定的比特ID与指定的授权码进行绑定
按Bit-ID为授权码解绑比特ID DELETE /sns/{sn}/bitids/guid/{guid} 根据Bit-ID查询指定的比特ID与指定的授权码进行解绑
按喷码为授权码绑定比特ID POST /sns/{sn}/bitids/label/{label} 根据喷码查询指定的比特ID与指定的授权码进行绑定
按喷码为授权码解绑比特ID DELETE /sns/{sn}/bitids/label/{label} 根据喷码查询指定的比特ID与指定的授权码进行解绑

终端标识

接口名称 URL 接口概述
获取终端标识 GET /custom_ids/{custom_id} 查询终端标识信息列表

授权码终端标识

接口名称 URL 接口概述
删除终端标识 DELETE /sns/{sn}/custom_ids/{custom_id} 删除指定授权码的终端标识。已激活的终端标识无法被删除

设备

接口名称 URL 接口概述
查询指定设备 GET /machines/{id} 根据设备id查询指定的设备
修改指定设备 POST /machines/{id} 根据设备id修改指定的设备的状态
删除指定设备 DELETE /machines/{id} 根据设备id删除指定的设备

角色

接口名称 URL 接口概述
查询角色 POST /roles/data 根据指定条件查询角色

角色用户

接口名称 URL 接口概述
遍历角色的用户 GET /roles/role/{guid}/users 遍历指定角色下用户
批量绑定用户 POST /roles/role/{guid}/users 查找指定的角色，为角色批量绑定用户
批量解绑用户 DELETE /roles/role/{guid}/users 查找指定的角色，为角色批量解绑用户

角色特征项

接口名称 URL 接口概述
遍历角色的特征项 GET /roles/role/{guid}/features 遍历指定角色的特征项

报表

接口名称 URL 接口概述
登录峰值报表 POST /reports/sn/peak 批量获取授权码在指定时间范围内的每月（或每日）登录峰值报表
用户使用时长报表 POST /reports/users/usage 获取（批量）授权码绑定的（批量）用户在指定时间范围内使用的分钟数
用户使用错误报表 POST /reports/users/errors 获取（批量）授权码绑定的（批量）用户在指定时间范围内使用返回的错误码总数

帐号授权专用接口

身份源

接口名称 URL 接口概述
获取身份源列表 GET /dev/identity-providers 根据业务guid查询绑定的身份源，使用身份源类型去筛选身份源，返回符合条件的身份源列表
获取指定身份源信息 GET /dev/identity-providers/{guid} 获取指定身份源的信息，可输入业务guid判断是否有关联关系

用户管理

接口名称 URL 接口概述
遍历身份源的用户 GET /dev/users 遍历指定身份源下的用户
遍历用户 GET /dev/users 遍历（关联指定授权码）（关联指定客户的）用户列表
获取指定用户信息 GET /dev/users/{guid} 获取指定用户的信息
修改指定用户信息 POST /dev/users/{guid} 修改指定用户的信息。只对传入的值进行修改
重置指定用户密码 POST /dev/users/{guid}/password/reset 更新指定用户的密码
删除指定用户 DELETE /dev/users/{guid} 删除指定用户
添加用户关联身份源 POST /dev/users 根据开发商的用户id在指定身份源下查找关联的用户，存在则返回，不存在则新建用户，与身份源进行关联。设置用户的头像地址时，添加或修改用户头像
添加用户 POST /dev/users 添加用户。设置用户的头像地址时，添加或修改用户头像