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：