You need to enable JavaScript to run this app.
导航
接口管理概览
最近更新时间:2024.07.11 17:32:52首次发布时间:2023.03.21 19:29:51

1. 产品概述

目前系统支持对OpenApi进行管理,包括接口应用注册,系统当前支持Api权限管理等。在本模块我们将结合实际业务操作中的应用场景,进行详细的操作说明。

2. 使用限制
  • 项目管理员 可进入该模块。
  • OpenApi管理页面需根据客户环境配置后使用。

3. 操作步骤

点击 项目中心 - OpenApi管理,支持配置和管理普通接口或在线服务接口:

  • 普通接口:较低QPS,较高时延,适合分析和部分并发量低的场景。
  • 在线服务接口:高QPS,低延迟,适合大的并发量且实时的场景,开启此接口需提前配置Redis资源,如未配置资源直接进行调用,则调用失败。

图片

3.1 普通接口

展示系统目前支持的API,包含API名称、API路径、协议、方法类型、API文档等。
图片

3.2 在线服务接口

在线服务接口目前支持的接口包括:分群、标签、属性、idm、行为和明细数据接口。详情查看文档在线服务接口文档
标签在线服务配置
点击「标签在线服务配置」按钮进入配置页面。在当前页面支持按照主体及业务系统筛选标签,需注意,可选择的业务系统必须是已经配置在在线服务接口中的业务系统。
支持在列表页删除标签。
图片
点击“新增标签”按钮进入配置页面,支持选择主体及该主体下的标签,标签支持多选。
*注意:新增标签的数量与用户资源限制相关。
图片
分群在线服务配置
点击“分群在线服务配置”进入该页面。在当前页面支持按照主体及业务系统筛选标签,需注意,可选择的业务系统必须是已经配置在在线服务接口中的业务系统。
列表页展示分群名称,分群ID,以及导入状态,支持手动删除及更新。
图片
点击列表右上角“新增分群”,可选择分群进行导入。
图片
*注意:此处可选择的分群为分群列表中的所有分群,已导入的分群不可再进行选择,且可增加的分群数量,不超过系统支持的分群数量总和。
属性在线服务配置
点击“属性在线服务配置”进入该页面。在当前页面支持按照主体及业务系统筛选标签,需注意,可选择的业务系统必须是已经配置在在线服务接口中的业务系统。
支持在列表页删除属性或者更新属性,即当上游属性更新后,需要手动更新配置的属性。
图片
支持新增属性。支持选择主体及该主体下该操作用户有权限的属性,标签支持多选。
*注意:新增属性的数量与用户资源限制相关。
图片
idmapping在线服务配置
点击“idmapping在线服务配置”进入该页面。在当前页面支持按照主体及业务系统筛选标签,需注意,可选择的业务系统必须是已经配置在在线服务接口中的业务系统。
支持在列表页面删除导入的id。
图片
支持新增导入id。在配置页选择导入的主体,并选择导入id及其满足的导入关系。主体和主体之间,ID和ID之间都是或的关系。
图片
行为数据服务配置
点击“行为数据服务配置”进入该页面。在当前页面支持按照主体筛选,支持在列表页面编辑和删除导入的行为数据。
点击右上角「新增行为数据」,在弹窗中选择主体、数据源(表)、行为事件(列),并设置保留最近n天的数据。
图片
明细数据服务配置
点击“明细数据服务配置”进入该页面。在当前页面支持按照主体筛选,支持在列表页面编辑和删除导入的行为数据。
点击右上角「新增明细数据」,在弹窗中选择主体、数据源(表)、明细(列),并设置保留最近n天的数据。
图片