Tüm API istekleri, bir API anahtarı kullanarak kimlik doğrulama gerektirir. Bu kılavuz, API anahtarlarını güvenli bir şekilde nasıl oluşturacağınızı, yöneteceğinizi ve kullanacağınızı açıklar.
Bir API anahtarı almak için bir iloveQR hesabına sahip olmanız ve bir organizasyonun parçası olmanız gerekir.
Giriş yapın veya bir hesabınız yoksa bir hesap oluşturun.
API anahtarlarınızı yönetmek için Kontrol Paneli → Geliştiriciler'e gidin.
'API Anahtarı Oluştur' butonuna tıklayın, açıklayıcı bir isim verin ve oluşturulan anahtarı güvenli bir şekilde saklayın.
Her istekte API anahtarınızı X-API-Key başlığına ekleyin:
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"Çoğu API uç noktası, URL yolunda bir organizasyon ID'si gerektirir. Organizasyon ID'nizi kontrol paneli ayarlarında veya organizasyonlar uç noktasına istek yaparak bulabilirsiniz.
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 çağrılarını her zaman sunucunuzdan yapın. Tarayıcıda, mobil uygulamalarda veya kullanıcılar tarafından görüntülenebilecek herhangi bir kodda API anahtarlarını asla dahil etmeyin.
API anahtarlarınızı ortam değişkenlerinde saklayın, kod tabanınızda değil. Bu, sürüm kontrolü yoluyla kazara açığa çıkmayı önler.
Periyodik olarak yeni API anahtarları oluşturun ve eski olanları iptal edin. Bir anahtarın tehlikeye girdiğinden şüpheleniyorsanız, hemen iptal edin.
Kimlik doğrulama başarısız olduğunda, API bu hata yanıtlarından birini döndürür:
| Durum Kodu | Hata | Açıklama |
|---|---|---|
401 | UNAUTHORIZED | Eksik veya geçersiz API anahtarı |
403 | FORBIDDEN | API anahtarı bu işlem için izin vermiyor |
403 | API_KEY_REVOKED | API anahtarı iptal edildi |
{
"statusCode": 401,
"message": "Invalid or missing API key",
"error": "Unauthorized"
}Artık kimlik doğrulamayı anladığınıza göre, API'yi nasıl kullanacağınızı öğrenin: