系统的使用者分为两种:
- 普通用户(主要通过Web端页面访问系统,基于账号和密码的登录验证机制);
- 调用方(面向程序接入,主要通过API等方式查询系统数据,基于调用方和元素授权的验证机制);
如果您要使用API查询统计结果或者使用商业版本的JS图表引用功能,则需要首先创建调用方。系统拥有完善的授权验证、调用量监控和限流等功能,对外提供更为安全的API查询机制。
创建调用方
您可以根据需要创建任意数量的调用方,调用方基础信息包括:名称、所属部门和描述信息。
1、名称
- 必要字段,可使用英文、数字、下划线,长度限制:5 ~ 30个字符之间;
- 建议使用清晰、简洁、具有业务标识性的名称;
- 为了避免与统计组token混淆,系统为调用方名称添加统一前缀(caller:);
2、所属部门
- 必要字段,默认使用当前用户所在部门;
3、描述信息
- 用于描述当前调用方的用途信息;
调用方授权
调用方授权是指为调用方分配相应元素(统计项、数据视图)的访问权限。
授权分为三种方式:以统计工程为粒度的授权方式、以统计项为粒度的授权方式、以数据视图为粒度的授权方式(商业版功能)。
-
以统计工程为粒度的授权方式:为调用方申请某个工程访问权限,指定授权期限和申请原因,然后提交工单,待工程管理员审核通过后,该调用方即拥有当前工程下所有统计项的数据访问权限;
-
以统计项为粒度的授权方式:为调用方申请某个统计项访问权限,指定授权期限和申请原因,然后提交工单,待所属工程管理员审核通过后,该调用方即拥有该统计项的数据访问权限;
-
以数据视图为粒度的授权方式(商业版功能):为调用方申请某个自定义数据视图的访问权限,指定授权期限和申请原因,然后提交工单,待所属管理员审核通过后,该调用方即拥有该数据视图的数据访问权限(注意:该功能用作js页面引用,可在外部系统中嵌入当前数据视图,除了视图访问权限之外,调用方还需要同时申请视图所包含的统计项或统计工程的授权);
为调用方申请相应工程、统计项、数据视图的授权并且审核通过后,系统由于缓存原因约5分钟后生效。
调用方授权信息有时效限制,到期后自动限制相关调用,为了避免影响正常使用,请及时续签相应元素的授权信息。
调用方状态
调用方状态分为:正常状态和冻结状态,运维管理员可以在调用方列表页冻结某个调用方,处于冻结状态的调用方将不再能调用任何API接口。
使用调用方
在调用方"管理页面",可以获取密钥信息。基于调用方名称和密钥可以执行调用API接口或者JS页面引用等功能。
请您参考: