Skip to main content

API 密钥认证

Legitmark 使用 API 密钥认证。您的 API 密钥标识您的平台并授权访问 Legitmark 服务。
需要 API 密钥?请参阅入门指南设置您的组织并在开发者设置中创建密钥。
在所有请求的 Authorization 标头中包含您的 API 密钥:
如果使用 TypeScript SDK,认证将自动处理:

安全模型

所有 API 通信使用 API 密钥进行认证。个人信息永远不会在标头、URL 或查询参数中传输,符合严格的数据保护标准。

API 密钥范围

密钥仅被授予组织所需的范围。常用合作伙伴范围: 启用私有媒体时,Legitmark 会授予 media:v2:private-read。没有该范围时,私有 CDN 组织的 GET /api/v2/sr/{sr_uuid} 会返回空媒体。

速率限制

为确保平台稳定性,可能会应用速率限制。如果收到 429 响应,请等待后重试。详情请参阅速率限制

安全最佳实践

API 密钥安全

  • 仅限授权系统访问 API 密钥
  • 使用环境变量存储 API 密钥
  • 实施密钥轮换程序
  • 监控 API 密钥使用异常

请求安全

  • 始终使用 HTTPS 进行 API 通信
  • 实施请求超时和重试逻辑
  • 对所有认证请求使用安全标头

测试认证

验证 API 密钥

使用简单的请求测试您的 API 密钥:

使用 SDK 测试

后续步骤

  1. 查看 分类体系 了解物品分类
  2. 实施 工作流程 用于服务请求
  3. 使用 私有 CDN — 如果组织将媒体放在公开 CDN 之外
  4. 设置 Webhook 用于实时通知