跳到主要内容

API 密钥

概述​

API 密钥(Application Programming Interface Key 的缩写)是用于对应用程序编程接口(API)进行身份验证和控制访问的代码或令牌。API 是一组规则和协议,允许不同的软件应用程序之间进行通信和交互。它们使开发人员能够在不理解底层技术细节的情况下,访问某个服务或平台的特定功能或数据。

API 密钥是 API 的一种安全机制和访问控制方式。它们帮助 API 提供方确保只有经过授权的用户或应用程序才能使用其 API,防止未经授权的访问和潜在的滥用。以下是 API 密钥的工作原理概述:

  1. 生成:当开发人员或用户想要使用某个 API 时,通常需要从 API 提供方获取 API 密钥。这通常通过在提供方平台注册账户,并通过开发人员控制台创建 API 密钥来完成。
  2. 身份验证:在调用 API 时,API 密钥通常包含在请求头、查询参数或其他指定位置。当 API 接收到请求时,它会检查提供的 API 密钥以验证调用者的身份。
  3. 授权:除了身份验证之外,API 密钥还可以用于控制用户或应用程序的访问权限级别。不同的 API 密钥可能具有不同的权限级别,允许某些密钥仅访问 API 的某些部分或执行特定操作。
  4. 使用跟踪:API 密钥可以与使用限制相关联,这些限制控制用户或应用程序在指定时间范围内可以发出的请求数量。这可以防止单个用户对 API 过度使用,有助于保持 API 的性能和所有用户的可用性。
  5. 安全性:尽管 API 密钥是一种方便的访问管理方式,但它们也伴随着安全方面的考虑。如果 API 密钥被泄露,未经授权的人员可能会获得 API 的访问权限并可能滥用它。因此,开发人员和 API 提供方需要实施安全措施,如加密、速率限制和定期密钥轮换,以减轻这些风险。
  6. 最佳实践:为了确保 API 密钥的安全性和正确使用,开发人员应遵循最佳实践,例如:
    • 保持 API 密钥的机密性,避免在公开的代码仓库中硬编码。
    • 实现 HTTPS 以确保通信安全。
    • 为不同的应用程序使用强大且唯一的 API 密钥。
    • 定期审查和审计 API 密钥的使用情况,以识别任何异常。

API 密钥列表​

可以通过点击侧边菜单中的 设置,然后点击 API 密钥 来管理 API 密钥列表。它会显示您创建的 API 密钥列表。

设置 apikey 列表

搜索 API 密钥​

您可以在 API 密钥列表视图 的搜索栏中输入关键字,然后点击 搜索 进行搜索。通过点击 清除 按钮,可以随时清除搜索结果。

API 密钥详情​

点击 API 密钥的名称可以查看其详细信息。

一个 API 密钥通常包含以下列:

  • Sid - API 密钥的 ID
  • 名称 - API 密钥的名称
  • 描述 - API 密钥的描述
  • 前缀 - 密钥的前缀
  • 创建时间 - 创建日期
  • 过期日期 - API 密钥的过期日期

添加 API 密钥​

任何人都可以添加 API 密钥,但用户只能添加自己的 API 密钥。操作步骤如下:

  1. 点击侧边菜单中的 设置,然后选择 API 密钥
  2. 点击 "+ 添加 API 密钥" 按钮
  3. 将显示一个表单。
  4. 提供 名称。
  5. 提供 过期日期。
  6. 点击 提交 按钮

点击 提交 按钮后,您将被带到密钥页面。请将 API 密钥复制并保存在安全的地方。密钥将不再显示。