APIドキュメンテーション

API v1

APIドキュメント

QRコードの生成、カスタマイズ、分析をアプリケーションに統合するためのREST APIです。わずか数回の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コードを作成する

分析

スキャン、場所、デバイスを追跡し、詳細なレポートをエクスポートする

Webhook

QRコードがスキャンされたときにリアルタイム通知を受け取る

なぜ私たちのAPIを選ぶのか

迅速かつ信頼性の高い

99.9%の稼働率SLAを持つ低遅延API

デフォルトで安全

スコープ付き権限を持つAPIキー認証

レート制限

明確なエラーレスポンスを伴う寛大な制限

SDKは近日公開予定

JavaScript、Python、PHPなどの公式SDKを開発中です。利用可能になった際に通知を受け取るためにサインアップしてください。

助けが必要ですか？

APIについて質問がある場合や支援が必要な場合は、これらのリソースを確認してください:

ヘルプセンターサポートに連絡開発者ダッシュボード