You need to enable JavaScript to run this app.
导航

管理飞连 OpenAPI 访问秘钥

最近更新时间2023.04.26 11:25:39

首次发布时间2023.04.26 11:25:39

在使用飞连 OpenAPI 之前,您需要在飞连管理后台创建 API 访问秘钥(AccessKey)供指定范围内的员工使用。本文介绍如何管理飞连 API 访问秘钥。

创建 Access Key

  1. 登录飞连管理后台。

  2. 在左侧导航栏,选择开放平台 > API 管理

  3. API 管理页面右上角,单击创建 Access Key

  4. 创建 Access Key 对话框,完成以下配置,并单击确定
    图片
    配置项说明:

    配置项

    说明

    权限范围

    设置当前 AccessKey 可以使用的员工范围,可选全公司或者特定部门

    • 全公司:企业内所有员工均可使用该 AccessKey 调用 OpenAPI。
    • 特定部门:在搜索部门下拉列表中,手动添加部门,支持添加多个。后续仅被添加的部门范围内的员工可以使用该 AccessKey 调用 OpenAPI。

    添加接口权限

    飞连 OpenAPI 按功能模块划分共计 68 个权限,您可以根据实际需要,配置当前 AccessKey 支持调用的接口权限范围。

    用途

    自定义用途信息,用于标识当前 AccessKey 的实际用途。

    AccessKey 调用频率限制

    使用该 AccessKey 授权调用 API 的总体频率限制。默认值 100 qps。

    单接口调用频率

    使用该 AccessKey 授权调用单个 API 的频率限制。默认值 20 qps。

    IP 白名单

    设置 API 请求的 IP 地址白名单。支持的格式为:

    • IP范围。例如,10.10.56.217-10.10.56.218。
    • CIDR。例如,10.10.0.0/24 或者 10.10.0.0。
      多个 IP 地址之间使用逗号或者空格间隔。
  5. 创建完成后,在列表中获取 AccessKey IDAccessKey Secret
    其中:

    • 确保 AccessKey 状态为启用状态。更多信息请参见启用或禁用 AccessKey
    • AccessKey Secret 需要单击显示,在 AccessKey 详情对话框查看。在对话框内可直接复制 AccessKey ID 或者 AccessKey Secret。
      图片

启用或禁用 AccessKey

已创建的 AccessKey 支持手动禁用,禁用后员工无法再使用该 AccessKey 调用 OpenAPI,后续可根据实际需要重新启用。
API 管理页面,找到指定 AccessKey,在操作列单击禁用启用

  • 禁用:当 AccessKey 为启用状态时,您可以根据需要选择禁用 AccessKey,禁用后员工无法再使用该 AccessKey 调用 OpenAPI。
  • 启用:当 AccessKey 为禁用状态时,您可以根据需要选择启用 AccessKey。
    图片

查看或编辑 AccessKey 详细信息

API 管理页面,找到指定 AccessKey,在操作列单击查看详情进入 AccessKey 详情页面,查看基本信息开发设置
图片

删除 AccessKey

API 管理页面,找到指定 AccessKey,在操作列单击删除

注意

删除后,无法再继续使用该 AccessKey 调用飞连 OpenAPI,也无再查看该 AccessKey 的历史调用记录。

图片