跳至主要内容

如何使用 API 密钥

要通过 Lumytic API 进行身份验证，请在请求头中以 apikey 字段包含您的唯一的 API 密钥。 此密钥用于验证您的身份并授权访问您的 Lumytic 实例。

您发送给 API 的每个请求都必须包含此请求头，以确保正确的身份验证和安全校验。 没有有效的 API 密钥的请求将被拒绝，并返回身份验证错误。

HTTP 请求示例​

  GET /product_development/v1/series

  Host: api.lumytic.com

  ApiKey: YOUR_API_KEY_HERE

  Content-Type: application/json

使用 cURL 的示例​

  curl -X GET "https://api.lumytic.com/product_development/v1/series " 

  -H "ApiKey: YOUR_API_KEY_HERE" \

  -H "Content-Type: application/json"

使用 API 密钥时，您应遵循以下指南：

  • 将 YOUR_API_KEY 替换为您在 Lumytic 客户门户的“开发人员面板”中生成的密钥。
  • 务必保护您的 API 密钥隐私，切勿将其暴露在客户端代码或公共存储库中。
  • 对所有 API 请求使用 HTTPS 端点，以确保您的数据在传输过程中是加密的。
  • 如果您怀疑 API 密钥已泄露，请立即从您的 Lumytic 账户设置中重新生成。
  • 可以随时通过 Lumytic 客户门户管理、重新生成或撤销 API 密钥。

为获得更专业的 Lumytic API 使用体验，您可以遵循以下最佳实践：

  • 安全地存储您的 API 密钥，避免在公共或不安全的环境中共享它。
  • 如有必要，定期检查和轮换 API 密钥以维护安全性。
  • 始终使用加密连接 (HTTPS) 进行所有 API 交互。

无效身份验证的错误响应​

如果请求中缺少、过期或使用了无效的 API 密钥，Lumytic API 将返回 401 Unauthorized 错误（未经授权）。 这表明请求无法通过身份验证，对所请求资源的访问被拒绝。

响应通常包含一个解释问题的错误消息，帮助您识别并纠正身份验证问题。 始终确保您的 API 密钥有效、处于活动状态并包含在请求头中，以避免此错误。

响应示例

{
  "code": "900901",

  "message": "Invalid Credentials",

  "description": "Invalid Credentials. Make sure you have provided the correct security credentials"
}
在此页面上