API 文件

API v1

API 文檔

使用我們的 REST API 將 QR 碼生成、自訂和分析集成到您的應用程序中。僅需幾個 API 調用即可構建強大的 QR 碼工作流程。

快速入門

在幾分鐘內進行您的第一次 API 調用。以下是如何創建 QR 碼：

獲取您的 API 金鑰

註冊或登錄，然後訪問開發者頁面創建 API 金鑰。

進行您的第一次請求

在 X-API-Key 標頭中使用 API 金鑰：

示例請求

curl -X POST \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "URL",
    "name": "My Website QR",
    "data": {
      "url": "https://example.com"
    }
  }'

示例響應

{
  "id": "qr_abc123",
  "type": "URL",
  "name": "My Website QR",
  "shortUrl": "https://ilqr.co/abc123",
  "data": {
    "url": "https://example.com"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "totalScans": 0
}

身份驗證

所有 API 請求都需要使用 API 金鑰進行身份驗證。將您的金鑰包含在請求標頭中：

X-API-Key: your_api_key_here

安全提示： 切勿在客戶端代碼中暴露您的 API 金鑰。始終從您的伺服器進行 API 調用或使用環境變數。

基本 URL

所有 API 端點均相對於以下基本 URL：

https://api.iloveqr.com/api/v1

速率限制

API 請求受到速率限制，以確保公平使用和平台穩定性：

短期

requests/second

中期

requests/10 seconds

長期

100

requests/minute

API 端點

探索我們按功能組織的全面 API 端點：

QR 碼管理

以程式化方式創建、更新和管理動態 QR 碼

批量操作

通過 CSV 匯入或 API 一次創建數百個 QR 碼

分析

跟踪掃描、位置、設備並導出詳細報告

Webhooks

當 QR 碼被掃描時接收實時通知

為什麼選擇我們的 API

快速且可靠

低延遲 API，99.9% 的正常運行時間 SLA

默認安全

API 金鑰身份驗證，具有範圍權限

速率限制

慷慨的限制和清晰的錯誤響應

SDK 即將推出

我們正在為 JavaScript、Python、PHP 等開發官方 SDK。註冊以便在它們可用時獲得通知。

需要幫助嗎？

如果您對 API 有疑問或需要幫助，請查看這些資源：

幫助中心聯繫支持開發者儀表板