すべてのAPIリクエストにはAPIキーを使用した認証が必要です。このガイドでは、APIキーを安全に作成、管理、使用する方法を説明します。
APIキーを取得するには、iloveQRアカウントを持ち、組織の一部である必要があります。
ダッシュボード → 開発者に移動してAPIキーを管理します。
'APIキーを作成'をクリックし、説明的な名前を付けて生成されたキーを安全に保存します。
すべてのリクエストでX-API-KeyヘッダーにAPIキーを含めてください:
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"ほとんどの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呼び出しを行ってください。ブラウザ、モバイルアプリ、またはユーザーが見ることができるコードで実行されるJavaScriptに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の使用方法を学びましょう: