~/docs/getting-started/api-key/

获取 API Key

API Key 是调用蜀农 API 的凭证。每个请求都必须携带有效密钥。

创建密钥

  1. 登录蜀农 API 控制台。
  2. 进入 API Keys 页面。
  3. 点击 创建 API Key,填写用途并确认。
  4. 复制并安全保存生成的密钥。

密钥通常以 sk_ 开头。完整密钥只会在创建后展示一次,关闭页面后无法再次查看。

配置环境变量

推荐将密钥配置到运行环境,而不是写在源码中:

# macOS / Linux
export SHUNONG_API_KEY="sk_xxxxx"

# Windows PowerShell
$env:SHUNONG_API_KEY = "sk_xxxxx"

Python 中读取:

import os

api_key = os.environ["SHUNONG_API_KEY"]

密钥管理建议

  • 为不同环境或服务创建不同密钥。
  • 使用密钥权限、额度和有效期限制风险。
  • 日志中不要输出完整 API Key。
  • 发现泄露后立即撤销,并替换部署环境中的旧密钥。
  • 不要将 .env 文件提交到 Git 仓库。