Yolların girdileri ve yetkilendirme
Temel adres https://api.redditapihub.com üzerindedir. GET /v1/search gönderi ve yorum arar; /v1/posts gönderileri, /v1/comments yorumları getirir. Bu yollar düz kayıtlar döndürür, konuşma ağacını birleştirmez. GET /v1/item?id=... kimliği bilinen tek kaydı ister. id yalnızca item yolunda desteklenir; posts veya comments sorgusuna eklenebilen bir filtre değildir. Her yol için uygun girdiyi istemcinizde ayrı oluşturun.
GET /v1/subreddits?prefix=program&limit=3 topluluk adının başlangıcını sorgular ve en fazla üç sonuç ister. prefix, gönderi metnindeki q araması değildir. Topluluk sayımlarının küresel olarak kesin olması veya yanıtın alfabetik sıralanması garanti edilmez. Bu listeyi tam arşiv envanteri olarak yorumlamayın. Dönen adlarla başka bir veri yoluna geçerseniz o isteğin koşullarını ve yanıtını ayrıca değerlendirin.
Veri alma isteklerinde Authorization: Bearer YOUR_API_KEY ve X-API-Key: YOUR_API_KEY başlıklarının ikisi de desteklenir; birini seçin. Gerçek anahtar sunucunuzun gizli yapılandırmasında tutulmalıdır. Hesap panelinin Secure HttpOnly çerezi farklı bir oturum içindir ve bu başlığın yerine geçmez. Hesap, anahtar ve bakiye redditapihub.com alanına aittir. Başka markanın anahtarıyla burada aynı hesaba erişilmez.
Arama filtreleri ve yanıtı yorumlama
Arama, gönderi ve yorum sorgularında q, subreddit, author, kind, from, to, min_score, limit ve page kullanılabilir. kind değerleri post veya comment biçimindedir. Tarihler UTC esaslı YYYY-MM-DD biçimindedir; to belirtilen günü kapsar. min_score minimum puan koşuludur, sıralama değildir. parent_id ve link_id sorgu filtresi değildir. item ve topluluk yollarının aynı arama parametrelerini kabul ettiğini varsaymayın.
limit ve page 1–100 aralığındadır. Arama türündeki sorgularda istek başına en fazla 100 kayıt, sorgu başına en fazla 100 sayfa vardır. Her sayfa ayrı istenir. Sonuçlar arşiv belge sırasındadır; tarih, ilgi veya puan sırası değildir. Sayfa tekrarı veya tarih dilimleri bütün eşleşmeleri ve tekrarsız toplamayı garanti etmez. Kendi istemcinizde hangi koşul ve sayfaları sakladığınızı izleyin.
Toplam kayıt sayısında eq kesin değeri, gte alt sınırı, unknown veya null güvenilir toplamın bulunmadığını belirtir. Toplam, sayfa sayısı değildir. Kesin değer bile bütün kayıtları kaydettiğinizi kanıtlamaz. Okumak veya saymak için ağaç gerekmez. İlişkileri incelemek isterseniz mevcut parent_id ya da link_id alanlarıyla isteğe bağlı yerel gruplama yapabilirsiniz. Eksik üst kayıtlar veya yorumlar bu işlemle geri getirilemez.
Kamuya açık durum ve hata davranışı
GET /v1/status anahtarsız ve ücretsizdir. Sabit hizmet kapsamını ve HTTP uygulamasının yanıtını gösterir. Arşiv kaynağını, arama işleyişini, kayıt varlığını veya bakiyeyi kontrol etmez. Bu nedenle başarılı durum yanıtı veri yolunun çalıştığının kanıtı değildir. İstemci her veri isteğinin HTTP durumunu ve içeriğini kendi bağlamında değerlendirmeli, boş başarılı sonuçla hata durumunu birbirine karıştırmamalıdır.
İstemciler sık karşılaşılan HTTP hata kodlarıyla karşılaşabilir. 400 kodu geçersiz istek yapısını, 401 kodu eksik veya geçersiz API anahtarını belirtir. 402 kodu yeterli kredi bulunmadığını gösterirken, 429 kodu aşırı istek sınırına ulaşıldığını işaret eder. Bu kodlar standart HTTP uygulamalarına sadık kalır ve istemci hatası yönetimi için kritiktir.
Geçersiz istek bakiyeden düşülmez; üst kaynak hatasında ayrılan kredi geri verilir. Başarılı veri alma ise boş sonuçta da bir kredi harcar. İstemci bağlantısı kopmadan sunucuda ücretli başarı oluşmuş olabilir ve başarılı tekrar ayrıca ücretlidir. Parametre veya anahtar hatasını düzeltin; hız sınırında yeni gönderimi erteleyin. Bütün hata türlerini aynı otomatik tekrar döngüsüne koymadan önce saklama durumunu ve tekrar bütçesini değerlendirin.
