API 密钥管理

API 密钥是用于验证发送到产品的传入 API 请求的令牌。Endpoint Central 提供了多种 REST API 以支持开箱即用的集成,并使客户能够使用这些 API 构建自己的集成。有关更多详细信息,请参阅 Endpoint Central 支持的 REST API - API Explorer

目录

  1. 生成 API 密钥
  2. 管理 API 密钥
  3. 保护 API 密钥

 

 

 

1. 生成 API 密钥

生成 API 密钥的步骤:

  • 导航到管理 > 集成 > API 密钥管理 > 生成密钥

应用程序选项:

  • 选择目标应用程序名称:
    • Service Desk Plus
    • Analytics Plus
    • 自定义集成
  • 如果选择 自定义集成,请提供 服务名称说明,并根据您的需求选择权限。最后,单击生成密钥以获取您的 API 密钥。

2. 管理 API 密钥

API 密钥管理选项:

创建 API 密钥后,它们将以表格形式列在 API 密钥管理页面中。

  • 删除:如果您不再打算使用特定的集成服务,或者不再需要该密钥,请使用 操作 列中的 删除密钥 选项。
  • 重新生成:API 密钥不应长期使用。请定期使用 操作 列中的 重新生成密钥 选项对其进行重新生成。
  • 停用:如果您正在管理其他用户创建的 API 密钥且无法重新生成该 API 密钥,请使用 操作 列中的 停用 API 密钥 选项。

3. 保护 API 密钥

保护 API 密钥的最佳实践:

  • 安全存储 API 密钥,并限制访问权限。
  • 只有授权人员才应有权访问。
  • 避免在应用程序中硬编码 API 密钥,以防止意外的数据泄露。
  • 不要将 API 密钥存储在源代码仓库中。

定期操作:

  • 定期重新生成 API 密钥。
  • 仅创建具有所需权限的 API 密钥。
  • 审核已生成的 API 密钥,并删除任何不需要的密钥。

安全措施:

  • 如果发现可疑的 API 密钥,请将其停用。
  • 联系支持团队并提供服务器日志以获取帮助。

由以下所信任