İçeriğe geç
Search docs
Search docs…

API anahtarları (Developers sayfası)

Kendi betikleriniz ve uygulamalarınızda Quran Gallery verisini kullanmak için kişisel API anahtarları üretin — Developers sayfasından üretin, kopyalayın, geri çekin.

Bu sayfada

🌐 Bu çeviri topluluk incelemesi altındadır. Bir hata veya doğal olmayan ifade fark ettiniz mi? Aşağıdaki Bu sayfayı GitHub’da düzenle bağlantısına tıklayıp iyileştirme önerin.

Quran Gallery üzerinde bir şey inşa ediyorsanız — bir yan proje, kişisel pano, otomasyon betiği — bir tarayıcı oturumuna ihtiyaç duymadan isteğin sizden geldiğini kanıtlayan kişisel API anahtarları üretebilirsiniz.

API anahtarları, hesabınızdaki Developers sayfasından tamamen yönetilir.

Quick Start kullanım bloğunu, Create Key formunu ve Keys listesini gösteren Developers sayfası

Developers sayfasına nasıl ulaşılır

accounts.qurangallery.com‘a giriş yapın, sonra accounts.qurangallery.com/developers‘a gidin.

API anahtarı nedir

Bir API anahtarı şuna benzer uzun bir gizli dizidir:

qg_abc123def456...

qg_ ön eki, bunun bir Quran Gallery anahtarı olduğunu işaretler. Bir Quran Gallery isteğine Authorization: Bearer ... başlığında gönderdiğinizde, sunucu isteği siz yapmışsınız gibi davranır. Yani bir API anahtarı, programatik kullanım için kapsamlı, hesabınıza giden bir parola olarak işlev görür — öyle muamele edin.

Anahtar oluşturma

  1. Developers sayfasında Create New Key kartını bulun.
  2. Açıklayıcı bir ad yazın — "Madrasah progress export script", "My Raspberry Pi dashboard", "Local dev". Ad sadece sizin için — anahtar listesinde görünür.
  3. Create key‘e basın.

Yeni anahtar sayfanın üstünde, tam değeri görünür halde yeşil bir kartta belirir. Tam anahtarı göreceğiniz tek zaman bu. Kopya simgesine basıp panonuza alın, sonra güvenli bir yere saklayın.

Anahtar oluşturduktan sonra Developers sayfası — yeşil API Key Created kartı tam anahtarı, hemen kopyalama uyarısını, kopya düğmesini ve Done düğmesini gösteriyor

Done‘a bastıktan sonra yeşil kart kaybolur ve o andan itibaren anahtar listesinde yalnızca ilk birkaç karakteri (“start”) görünür. Tam değeri yeniden almanın yolu yok — kaybederseniz yeni bir anahtar oluşturmalı ve eskisini silmelisiniz.

Anahtar listesi

Oluşturma formunun altında hesabınızdaki her anahtarı görürsünüz.

Yeşil kart kapatıldıktan sonraki Developers sayfası, API Keys listesinde tek bir girdi — ad, Active durum etiketi, anahtar prefix'i, oluşturulma tarihi ve sil çöp simgesi

Her anahtar için:

  • Ad — oluştururken yazdığınız.
  • DurumActive (yeşil) veya Disabled (gri).
  • Start — anahtarın ilk birkaç karakteri, qg_abc12... gibi.
  • Created — anahtarın oluşturulma tarihi.

Her satırın sağında, çöp simgesi anahtarı siler. Silme kalıcı ve anlık — silinen anahtarı kullanan herhangi bir betik veya uygulama bir sonraki istekte 401 Unauthorized almaya başlar.

Anahtar kullanma

Authorization başlığında gönderin:

Authorization: Bearer qg_abc123def456...

Developers sayfasındaki kullanım kartı, kopyalanacak tam formatı gösterir. Aynı anahtar, anahtar kimliğini destekleyen her Quran Gallery hizmetinde sizi kimlik doğrulamasından geçirir.

API anahtarı istekleri tarayıcı oturumunu atlar; CI işlerinden, zamanlanmış görevlerden, mobil uygulamalardan kullanabilirsiniz.

Hız sınırları

Her API anahtarı dakikada 60 istek ile sınırlıdır, kayar pencere. Kişisel kullanım ve çoğu betik için yeterli. Aşarsanız API HTTP 429 döndürür.

Askıya alınmış veya silinmiş hesapların API anahtarları hemen çalışmayı keser.

Anahtarları döndürme

En iyi uygulama, şu durumlarda döndürmektir:

  • Anahtar içeren bir dizüstü veya cihaz kaybolmuş ya da satılmış.
  • Anahtarı artık erişime ihtiyacı olmayan bir iş arkadaşıyla paylaştınız.
  • Çok zaman geçti ve döndürülmemiş bir sır bırakmak istemiyorsunuz.

Döndürme iki adımlı manuel bir akıştır:

  1. Açıklayıcı bir adla yeni bir anahtar oluşturun.
  2. Betiklerinizi/uygulamalarınızı yeni anahtarı kullanacak şekilde güncelleyin.
  3. Her şey yeniye geçince eskisini silin.

Otomatik döndürme özelliği bugün yok.

Anahtarımı kaybettim

Quran Gallery kayıp anahtarı geri alamaz. Eski anahtarı listeden silin ve yenisini oluşturun. Betiğinizi yeni değerle güncelleyin.

Güvenlik kontrol listesi

  • Bir anahtarı asla git’e commit etmeyin. Bir .env dosyası (ve .gitignore‘a ekleyin) kullanın.
  • Bir anahtarı asla halka açık Slack, Discord, GitHub issue veya AI sohbete yapıştırmayın. Anahtarları tam olarak parolalar gibi muamele edin.
  • Proje başına bir anahtar kullanın, her şey için bir tane değil.
  • Bir anahtarın kompromize olduğundan şüpheleniyorsanız önce silin, sonra yenisini oluşturun. Sıralama önemli.
  • Anahtarları istemci tarafındaki koda gömmeyin (bir kullanıcının tarayıcısında çalışan JavaScript, mobil uygulama binary’leri).

Sık hatalar

HataÇözüm
API çağırırken 401 UnauthorizedAnahtarınız silindi, devre dışı bırakıldı veya hiç oluşturulmadı. Yenisini oluşturun.
403 Account suspendedAnahtarın sahibi hesap askıya alınmış. Bkz. Askıya alınan hesaplar.
429 Too Many RequestsDakika başına sınıra ulaştınız. Geri çekilin ve tekrar deneyin.
Sayfada “Failed to load API keys”Geçici ağ hatası. Sayfayı yenileyin.
Bu sayfayı GitHub'da düzenle