在使用飞连 OpenAPI 之前,您需要在飞连管理后台创建 API 访问秘钥(AccessKey)供指定范围内的员工使用。本文介绍如何管理飞连 API 访问秘钥。
登录飞连管理后台。
在左侧导航栏,选择集成管理 > API 管理。
在 API 管理页面右上角,单击创建 Access Key。
在创建 Access Key 对话框,完成以下配置,并单击确定。
配置项说明:
配置项 | 说明 |
---|---|
权限范围 | 设置当前 AccessKey 可以使用的员工范围,可选全公司或者特定部门。
|
添加接口权限 | 飞连 OpenAPI 按功能模块划分共计 68 个权限,您可以根据实际需要,配置当前 AccessKey 支持调用的接口权限范围。 |
用途 | 自定义用途信息,用于标识当前 AccessKey 的实际用途。 |
AccessKey 调用频率限制 | 使用该 AccessKey 授权调用 API 的总体频率限制。默认值 100 qps。 |
单接口调用频率 | 使用该 AccessKey 授权调用单个 API 的频率限制。默认值 20 qps。 |
IP 白名单 | 设置 API 请求的 IP 地址白名单。支持的格式为:
多个 IP 地址之间使用逗号或者空格间隔。 |
创建完成后,在列表中获取 AccessKey ID 和 AccessKey Secret。
其中:
已创建的 AccessKey 支持手动禁用,禁用后员工无法再使用该 AccessKey 调用 OpenAPI,后续可根据实际需要重新启用。
在 API 管理页面,找到指定 AccessKey,在操作列单击禁用或启用。
在 API 管理页面,找到指定 AccessKey,在操作列单击查看详情进入 AccessKey 详情页面,查看基本信息与开发设置。
在 API 管理页面,找到指定 AccessKey,在操作列单击删除。
注意
删除后,无法再继续使用该 AccessKey 调用飞连 OpenAPI,也无再查看该 AccessKey 的历史调用记录。