跳到主要内容

API 密钥

API 密钥用于标识向 GVR 开发者 API 发出请求的开发者账户。

管理密钥​

你可以在 GVR 应用中创建、查看、轮换或删除 API 密钥。本文档介绍密钥出现在账户中后如何使用。

使用密钥​

通过 apiKey 请求标头将密钥发送到开发者 API 端点：

apiKey: YOUR_API_KEY

发送 JSON 请求时，还应包含常规 JSON 内容类型：

Content-Type: application/json
apiKey: YOUR_API_KEY

上传文件时，请在 multipart 表单请求中一并发送密钥。

密钥生命周期​

如果你在 GVR 应用中轮换或删除密钥，使用旧密钥的请求将返回：

{
  "error": "Invalid API key"
}

安全提示​

  • 将密钥存储在服务器端环境变量中。
  • 不要将密钥提交到代码仓库。
  • 不要在公开的前端构建产物中暴露密钥。
  • 如果密钥意外泄露，请在 GVR 应用中轮换密钥。