跳到主要内容
版本:域名注册

API密钥管理

操作背景

本文将帮助您了解如何创建、管理和使用域名服务的API密钥。

功能说明

API密钥是调用域名服务API接口的重要凭证,包含Access Key、Secret Key和Account ID三个部分。通过API密钥,您可以安全地调用各种域名管理接口。

前提条件

  • 已登录宝塔域名管理控制台
  • 账号处于正常状态
  • 已了解API接口的基本使用方法

操作步骤

创建API密钥

  1. 登录堡塔域名管理后台,在左侧导航栏选择【域名管理】

  2. 在域名管理页面,点击左侧菜单【域名安全】,进入域名安全页面后,点击顶部选项卡【API管理】

    API管理选项卡

  3. 在API管理页面,点击【创建API密钥】按钮

    创建API密钥

  4. 在弹出的创建窗口中,填写相关信息:

    创建API密钥表单

    • 密钥名称:为API密钥设置一个易于识别的名称
    • IP白名单:输入允许调用API的IP地址,每行一个IP(可选)
    安全提示

    为了安全,建议设置IP白名单,仅允许指定的IP地址调用API接口。每行一个IP地址。

  5. 点击【创建】按钮完成API密钥创建

  6. 创建成功后,系统会显示API密钥信息:

    API密钥创建成功

    • Access Key:API访问密钥
    • Secret Key:API密钥
    • Account ID:账户ID
    重要提醒

    API密钥创建成功!请立即保存以下信息,关闭后将无法再次查看:

    • Secret Key 一旦关闭此窗口将无法再次查看
    • 请将密钥信息安全保存
    • 不要在代码中硬编码密钥信息
  7. 点击每个密钥后面的【复制】按钮,将密钥信息保存到安全的地方

  8. 点击【复制全部信息】按钮可以一次性复制所有密钥信息

管理API密钥

创建完成后,您可以在API管理页面看到已创建的API密钥:

API密钥列表 可以进行以下操作:

  • 编辑:修改密钥名称和IP白名单
  • 重新生成:重新生成Secret Key(原密钥将失效)
  • 删除:删除不再使用的API密钥

代码安全

# ❌ 错误做法:在代码中硬编码
access_key = "ak_123456789"
secret_key = "sk_987654321"

# ✅ 正确做法:使用环境变量
import os
access_key = os.getenv('API_ACCESS_KEY')
secret_key = os.getenv('API_SECRET_KEY')

IP白名单设置

建议根据不同场景设置IP白名单:

  • 开发环境:限制为开发者的IP地址
  • 生产环境:限制为服务器的固定IP地址
  • CI/CD:添加构建服务器的IP地址

联系客服

如在使用过程中遇到问题,请联系宝塔客服:

联系时请提供:

  • 账号信息
  • API密钥名称(不要提供密钥内容)
  • 错误信息或问题描述
  • 相关操作截图(如有)

相关文档

开发建议
  • 在开始开发前,建议先阅读API概览了解签名认证机制
  • 使用API前先在小范围环境测试
  • 保存好示例代码,便于快速集成
  • 定期检查和更新API密钥