跳到主要内容

认证

ArchiCore 使用 API 密钥进行认证。

获取 API 密钥​

  1. 登录 ArchiCore
  2. 前往 设置 → 开发者
  3. 点击 生成 API 密钥
  4. 复制并安全存储您的密钥
注意

API 密钥只显示一次。请安全存储！

使用 API 密钥​

在 Authorization 标头中包含密钥：

curl -H "Authorization: Bearer sk_live_xxxxx" \
  https://api.archicore.io/api/v1/projects

或作为查询参数（不推荐）：

curl "https://api.archicore.io/api/v1/projects?api_key=sk_live_xxxxx"

密钥类型​

前缀类型描述
sk_live_生产对您的账户具有完全访问权限
sk_test_测试有限访问，用于开发

密钥权限​

API 密钥继承您账户级别的权限：

权限免费专业企业
读取项目✓✓✓
创建项目✓✓✓
分析✓✓✓
Webhooks-✓✓
团队访问--✓

撤销密钥​

要撤销 API 密钥：

  1. 前往 设置 → 开发者
  2. 在列表中找到密钥
  3. 点击 撤销

撤销的密钥将立即停止工作。

安全最佳实践​

  1. 永远不要提交 API 密钥到版本控制
  2. 使用环境变量存储密钥
  3. 定期轮换密钥（建议：每 90 天）
  4. 使用测试密钥进行开发
  5. 在仪表板中监控使用情况

环境变量​

# .env（添加到 .gitignore！）
ARCHICORE_API_KEY=sk_live_xxxxx
const client = new ArchiCore({
  apiKey: process.env.ARCHICORE_API_KEY
});

OAuth（即将推出）​

OAuth 2.0 支持计划用于团队集成。