API Kimlik Doğrulama

Tüm API istekleri, bir API anahtarı kullanarak kimlik doğrulaması 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.

API Anahtarı Alma

Bir API anahtarı almak için bir iloveQR hesabınızın olması ve bir organizasyonun parçası olmanız gerekmektedir.

Hesabınıza giriş yapın

Giriş yap veya bir hesap oluştur eğer bir tane yoksa.

Geliştiriciler sayfasına gidin

Dashboard → Developers bölümüne giderek API anahtarlarınızı yönetin.

Yeni bir API anahtarı oluşturun

'API Anahtarı Oluştur' butonuna tıklayın, ona açıklayıcı bir ad verin ve oluşturulan anahtarı güvenli bir şekilde saklayın.

API Anahtarınızı Kullanarak

Her istekte X-API-Key başlığında API anahtarınızı ekleyin:

İstek Başlığı

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"

Organizasyon ID

Çoğu API uç noktası, URL yolunda bir organizasyon kimliği gerektirir. Organizasyon kimliğinizi kontrol paneli ayarlarında bulabilir veya organizasyonlar uç noktasına bir istek yaparak öğrenebilirsiniz.

Kuruluşlarınızı Alın

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

Yanıt

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

Güvenlik En İyi Uygulamaları

API anahtarlarını istemci tarafı kodunda asla ifşa etmeyin.

Her zaman API çağrılarını sunucunuzdan yapın. API anahtarlarını tarayıcıda, mobil uygulamalarda veya kullanıcılar tarafından görüntülenebilecek herhangi bir kodda asla dahil etmeyin.

Çevre değişkenlerini kullanın

API anahtarlarınızı kod tabanınızda değil, ortam değişkenlerinde saklayın. Bu, sürüm kontrolü aracılığıyla kazara ifşayı önler.

Anahtarları düzenli olarak döndürün

API anahtarlarını periyodik olarak oluşturun ve eski olanları iptal edin. Bir anahtarın tehlikeye girdiğinden şüpheleniyorsanız, hemen iptal edin.

Kimlik Doğrulama Hataları

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ının bu işlem için izni yok.
403	API_KEY_REVOKED	API anahtarı iptal edildi.

Örnek Hata Yanıtı

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

Sonraki Adımlar

Artık kimlik doğrulamayı anladığınıza göre, API'yi nasıl kullanacağınızı öğrenin: