API管理
配置API
配置数据源
该数据源用于标签或群组对外提供API服务时,数据同步至哪个HBase数据库中,通过API查询HBase对外提供数据源。在使用API功能之前必须配置,否则标签/群组API功能将无法使用。
配置方法:
- 创建项目时,选择API访问的hbase数据源
- 项目创建后,进入“项目管理-项目配置”页面,修改API访问数据源
创建API
进入“群组分析-API管理”页面,新增API,填写如下信息:
- API名称:只能以字母,数字,下划线组成,不支持中文;
- 选择实体:选择将哪个实体下的标签或群组对外开放;
- 标签API:自定义输入与输出维度,可查询单个实例的全部标签,或者查询某标签下的全部实例;
- 输入维度:选择调用API时作为入参的标签;
- 输出维度:选择将哪些标签数据提供出去;
- 群组API:将已发布的群组数据通过API对外服务;
- 选择群组:选择实体下某个已发布群组对外开放数据;
- 输出维度:选择将该群组的哪些标签数据提供出去,比如将“活跃用户”这个群组中用户的用户ID、收入、职业、性别、偏好渠道对外提供服务;
- API描述:描述API信息或用途;
- 黑白名单:用于限制访问API的黑白名单,保障API访问的安全性。如果用户未建任何名单,可进入“黑白名单“新建。
tip
- 当黑白名单配置重合,白名单与黑名单冲突时,将以黑名单为准。若需冲突IP能够正常使用,将黑名单中的冲突IP去除即可;
- API查询时不受行级权限控制,可以通过设置输入输出维度的方式初步控制可访问的数据。
- 目前的数据同步工具FlinkX不支持数组类字段,所以Hive表中的数组类标签不会被同步至HBase中,数组类标签不支持API功能。
发布API
API创建完是未发布状态,点击“API管理”列表的发布按钮把API提交至API网关,系统将给出该API的调用URL。
tip
- API发布后若没有授权给用户,将不会产生TOKEN,仍然无法调用。
- 标签、群组、API之间存在上下游依赖关系,为保障API的来源数据,发布API前需确保上游标签、群组都处于发布状态,否则将无法发布。
授权用户
info
该功能仅旗舰版支持。其他版本直接使用创建者的Token做API调用即可。
点击“API管理”列表的授权按钮,授权用户,系统将为不同的用户产生不同的TOKEN,被授权的用户需要在“我的API-API详情”页面查看自己的API-TOKEN; 另外,进入API详情页的授权用户tab,可以查看每个授权用户的API调用情况,并管理授权情况。
tip
V4.3.2新增授权功能,对于历史API,用户可继续使用原Token,也可以授权用户后用新生成的Token调用。
其他操作
- 编辑:API编辑与创建步骤一致,且只有禁用后的API才可以编辑;
- 禁用:若管理员不想将某已发布的API对外提供服务,可禁用API。禁用后,API将不可调用;
- 授权:系统管理员或API创建者可以为API授权用户,且只有已发布的API支持授权;
- 删除:已下线的API支持删除。
查看API
点击API列表的名称即可进入API详情页
基本信息
如上图所示,基本信息包括支持格式、请求协议、请求方式、API ID、调用URL等。
- 关联数据:标签API显示的是实体名称,群组API为实体名称及关联的群组;
- 涉及的标签:群组API有这个字段,表示关联群组圈群规则中涉及的标签
tip
API管理的详情页不支持查看API-TOKEN,被授权的用户需要在“我的API-API详情”页面查看。
接口信息
接口信息包括输入参数、输出参数、请求示例,相关说明可见API调用。
授权用户
如下图所示,进入授权用户tab页,可查看不同用户的授权状态、调用API的情况,管理当前API被授权的用户。