API 文档

身份验证

API身份验证

所有API请求都需要使用API密钥进行身份验证。本指南解释了如何安全地创建、管理和使用API密钥。

获取API密钥

要获取API密钥，您需要拥有iloveQR帐户并成为组织的一部分。

登录到您的帐户

登录或创建一个帐户，如果您还没有。

导航到开发者页面

前往仪表板 → 开发者管理您的 API 密钥。

创建一个新的 API 密钥

点击 '创建 API 密钥'，给它一个描述性的名称，并安全地存储生成的密钥。

使用您的 API 密钥

在每个请求中将您的 API 密钥包含在 X-API-Key 头中：

请求头

curl -X GET \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: ilqr_your_api_key_here" \
  -H "Content-Type: application/json"

组织 ID

大多数 API 端点在 URL 路径中需要组织 ID。您可以在仪表板设置中找到您的组织 ID，或通过向组织端点发出请求来获取。

获取您的组织

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

响应

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

安全最佳实践

切勿在客户端代码中暴露 API 密钥

始终从您的服务器发出 API 调用。切勿在浏览器、移动应用或任何用户可查看的代码中包含 API 密钥。

使用环境变量

将您的 API 密钥存储在环境变量中，而不是在代码库中。这可以防止通过版本控制意外暴露。

定期轮换密钥

定期创建新的 API 密钥并撤销旧的。如果您怀疑某个密钥已被泄露，请立即撤销它。

身份验证错误

当身份验证失败时，API 返回以下错误响应之一：

状态码	错误	描述
401	UNAUTHORIZED	缺少或无效的 API 密钥
403	FORBIDDEN	API 密钥没有此操作的权限
403	API_KEY_REVOKED	API 密钥已被撤销

示例错误响应

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

后续步骤

现在您了解身份验证，学习如何使用 API：